eVision - User contributions [en]

Order Express Formulas

2021-02-02T21:28:00Z

Gwilliams:

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Length ====

Tokens: <code>LENGTH:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LENGTH:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms lengths to add together.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

==== Product Token Value ====

Tokens: <code>P: :</code> or <code>Product: :</code>

Format: <code>P:[token]:[value]</code>

When evaluating against a <code>QuoteProductMod</code>, gets the result from the product the modification is attached to by evaluating the <code>[token]</code> and <code>[value]</code> specified.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOptionCategory: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2019-05-03T13:33:31Z

Gwilliams: /* Product Token Value */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

==== Product Token Value ====

Tokens: <code>P: :</code> or <code>Product: :</code>

Format: <code>P:[token]:[value]</code>

When evaluating against a <code>QuoteProductMod</code>, gets the result from the product the modification is attached to by evaluating the <code>[token]</code> and <code>[value]</code> specified.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOptionCategory: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2019-05-03T13:31:32Z

Gwilliams: /* Products */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

==== Product Token Value ====

Tokens: <code>P: :</code> or <code>Product: :</code>

Format: <code>P:[token]:[value]</code>

When evaluating against a <code>QuoteProductMod</code>, gets the result from the product the modification is attached to by evaluating the <code>[token]</code> and <code>value</code> specified.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOptionCategory: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-05-04T12:23:09Z

Gwilliams: /* Special Style Options for a Given Category */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOptionCategory: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-05-04T12:12:50Z

Gwilliams: /* Style Option Selection Count */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-05-04T12:12:21Z

Gwilliams: /* Special Style Options for a Given Category */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-05-04T11:06:48Z

Gwilliams: /* Special Style Options for a Given Category */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-05-03T22:06:33Z

Gwilliams: /* Special Modification */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:D:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-05-03T22:00:51Z

Gwilliams: /* Special Style Options for a Given Category */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mod, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-03-19T15:29:11Z

Gwilliams: /* Number (Decimal) */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mode, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling to the Product

<code>/U</code> - Divide and Apply Ceiling to the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

<code>*R</code> - Multiply and Round the Product

<code>/R</code> - Divide and Round the Quotient

<code>*D</code> - Multiply and Apply Floor to the Product

<code>/D</code> - Divide and Apply Floor to the Quotient

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2018-03-19T15:22:30Z

Gwilliams:

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>, <code>/R</code>, <code>*R</code>, <code>/D</code>, <code>*D</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mode, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-04-26T20:47:29Z

Gwilliams: /* Special Style Options for a Given Category */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>. In the context of pricing, this will always be false, since the quote item being run through the formula helper is a product or a mode, and not a style option.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-04-10T18:54:34Z

Gwilliams: /* Quote Variables */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProjectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-04-10T18:54:21Z

Gwilliams: /* Quote Variables */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code> or <code>ProhectVariable:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-04-10T18:53:50Z

Gwilliams: /* Quotes */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>Project:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-04-10T18:53:31Z

Gwilliams: /* Quotes */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code> or <code>PROJECT:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-04-03T20:53:02Z

Gwilliams: /* Negation */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

<code>LIMIT:!1(O:123,O:456,O:789)</code> - Returns false if more than one style option matches

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-02-15T15:21:46Z

Gwilliams: /* Usage */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2017-02-15T15:20:57Z

Gwilliams: Add Permission AtomType

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>PERMISSION:</code> - [[#Permissions|Permission]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Permissions ===

Tokens: <code>PERMISSION:</code>

Format: <code>PERMISSION:[code]</code> or <code>PERMISSION:[context].[code]</code>

The value for the <code>[code]</code> parameter should match the <code>OEConfigurationCode</code> in the <code>OEConfigurations</code> table. The optional <code>[context]</code> represents the context of the permission, the default being <code>UserType</code> if one is not provided - which indicates that the permission should be returned for the currently logged in user. Other options for <code>[context]</code> are <code>ProjectStatus</code>, which checks against the current user and the status of the project; <code>None</code>, checks against the permissions' default value. Returns <code>true</code> or <code>false</code>.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2016-12-29T19:35:18Z

Gwilliams: /* Collection Atom */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

<code>COLLECTION:("Option A","Option B")</code> - Returns a collection with the elements "Option A" and "Option B"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2016-12-29T19:30:00Z

Gwilliams: /* Collection Atom */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

<code>INFIX: ["Option 1","Option 2"]</code> - Returns a collection with the elements "Option 1" and "Option 2"

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Back To [[Developer Page]]

Order Express Formulas

2016-05-20T14:06:55Z

Gwilliams: /* Specials */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-05-20T12:56:35Z

Gwilliams: /* Usage */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the list of atoms.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-05-04T17:56:30Z

Gwilliams: /* Dates */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code>, <code>DATETIME:"[datetime]"</code>, <code>DATETIME:Now</code>, or <code>DATETIME:UtcNow</code>

The value for <code>[datetime]</code> is a string representation of a date, or one of two keywords: <code>Now</code> or <code>UtcNow</code>. <code>Now</code> will return the users local time, where as <code>UtcNow</code> will return the users local time with the UTC offset applied. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-05-04T17:53:20Z

Gwilliams: /* Examples */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code> or <code>DATETIME:"[datetime]"</code>

The value for <code>[datetime]</code> is a string representation of a date. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Date Time and Time Span Atoms ===

<code>Quote:DateModified > (DateTime:UtcNow - TimeSpan:30)</code> - Returns true if the quote was modified withing the last 30 days.

<code>DateTime:"4/27/2016" + TimeSpan:1</code> - Returns the date 4/28/2016

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-05-04T15:49:19Z

Gwilliams: /* Usage */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Dates and Time Spans ===

Tokens: <code>DATETIME:</code>, <code>TIMESPAN:</code>

==== Dates ====

Tokens: <code>DATETIME:</code>

Format: <code>DATETIME:[datetime]</code> or <code>DATETIME:"[datetime]"</code>

The value for <code>[datetime]</code> is a string representation of a date. When writing infix expressions, enclose the <code>[datetime]</code> in double quotes, in order to distinguish operators such as <code>/</code> or <code>-</code> from date delimiters. See [https://msdn.microsoft.com/en-us/library/system.datetime.parse(v=vs.110).aspx#StringToParse here] for valid formats.

==== Time Spans ====

Tokens: <code>TIMESPAN:</code>

Format: <code>TIMESPAN:[timespan]</code> or <code>TIMESPAN:"[timespan]"</code>

The value for <code>[timespan]</code> is a string representation of a time span. When writing infix expressions and wishing to provide a negative time span, enclose the <code>[timespan]</code> in double quotes, in order to distinguish the <code>-</code> which indicates a negative. See [https://msdn.microsoft.com/en-us/library/se73z7b9(v=vs.110).aspx#Anchor_2 here] for valid formats.

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-05-04T15:29:20Z

Gwilliams: /* Valid Tokens */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>DATETIME:</code> - [[#Dates|Date]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>TIMESPAN:</code> - [[#Time_Spans|Time Span]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T18:30:41Z

Gwilliams: /* Collection Atom */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: ([1,2,3,4] + 5) == ([1,2,3,4,5,6] - 6)</code> - Returns true

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T18:29:58Z

Gwilliams: /* Collection Atom */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: [1,2] == [1,2]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T18:24:39Z

Gwilliams: /* Valid Operators */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

=== Collection ===

<code>+</code> - Add

<code>-</code> - Remove

<code>|</code> or <code>||</code> - Returns the first collection with the elements from the second collection that do not exist in the first added

<code>&</code> or <code>&&</code> - Returns the elements that existing in both collections

<code>=</code> or <code>==</code> - Returns true if the values in the two collections match in value and sequence

<code>!</code> or <code>!=</code> - Returns true if the values in the two collections do not match match in value and or sequence

<code>??</code> - Second Value if First is Null

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T18:16:14Z

Gwilliams: /* Collection Atom */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections: 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T18:16:01Z

Gwilliams: /* Collection Atom */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the elements from the second collection no included in the first: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections; 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T18:15:12Z

Gwilliams: /* Examples */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Collection Atom ===

<code>INFIX: [1,2,3,4] + 5</code> - Returns a collection with the elements 1, 2, 3, 4, and 5

<code>INFIX: [1,2,3,4] - 4</code> - Returns a collection with the elements 1, 2, and 3

<code>INFIX: [1,2] + [2,3]</code> - Returns a collection with the elements 1, 2, 2, and 3

<code>INFIX: [1,2] || [1,4]</code> - Returns a collection with the elements from the first collection, and the unique elements from the second: 1, 2, and 4

<code>INFIX: [1,2] && [1,4]</code> - Returns a collection with the elements that exist in both collections; 1

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T15:41:38Z

Gwilliams: /* Valid Tokens */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T15:41:02Z

Gwilliams: /* Usage */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Collections ===

Tokens: <code>COLLECTION:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COLLECTION:([atoms])</code> or <code><nowiki>[[atoms]]</nowiki></code>

Used to return a collection of atom values. The value for <code>[atoms]</code> is a comma separated list of atoms to evaluate.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T12:33:37Z

Gwilliams: /* Valid Tokens */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-04-18T12:32:36Z

Gwilliams: /* Valid Tokens */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COLLECTION:</code> - [[#Collections|Collection]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express - Advanced Troubleshooting

2016-03-02T15:22:25Z

Gwilliams: /* Duplicate DbProviderFactories */

__FORCETOC__

== Standalone Version ==
[[File:OrderExpressStandaloneDownload.png|thumbnail|Standalone Version Download]]
[[File:OrderExpressStandaloneExexecutable.png|thumbnail|Locating the Executable]]
In order to debug certain issues, eVision Support may provide you with a link to download a ''Standalone Version'' of Order Express. This version of Order Express does not require installation and is primarily used to identify whether an issue is caused by a broken installation, or with Order Express directly.

<ol>
<li>Open the link that was provided to you by eVision Support</li>
<li>Click the ''Download'' button on the page and save the file to your desktop</li>
<li>Extract the downloaded file to a folder. (Note: Ensure the file is not marked as "Blocked" before you perform the extraction.)</li>
<li>Open the folder and locate the executable file for the application</li>
<li>If the program loads up successfully, the issue is the result of the installation routine. Perform the ''Extended (Full) Uninstall'' on the [[Uninstalling_Order_Express|Uninstalling Order Express]] page.</li>
<li>If the program does '''not''' load successfully, the cause of the issue is within the application.</li>
<li>Ensure that you communicate the results of this test back to eVision Support for additional troubleshooting steps.</li>
</ol>

<div style="clear: both"></div>
== Standalone Version Will Not Connect ==
[[File:OrderExpress_Standalone_Unblock1.png|thumbnail|Opening the "Properties" window]]
[[File:OrderExpress_Standalone_Unblock2.png|thumbnail|Unblocking the file]]
There exists a security feature within Windows that can sometimes prevent Standalone Versions of Order Express from working correctly. Files that are downloaded from an non-trusted web location are marked as "Blocked" by default, preventing them from retrieving content from the internet. The solution for this issue is to "unblock" the downloaded file.

<ol>
<li>Right-click on the file that was downloaded from the internet.</li>
<li>Select <code>Properties</code> from the context menu.</li>
<li>Find the <code>Unblock</code> button at the bottom of the dialog, and click it.</li>
<li>The file can now be opened. If the file is a zip file, it can now be extracted.</li>
</ol>

'''Note:''' If the blocked file is a zip file, it ''must'' be unblocked prior to extracting it, or you will likely encounter issues with the unzipped files.

<div style="clear: both"></div>
== Duplicate DbProviderFactories ==

Due to an issue in certain software, you may receive the following error:
<code>The 'DbProviderFactories' section can only appear once per config file.</code>

This occurs because the [[Machine.config]] file on the computer contains erroneous information and must be fixed by hand.

<ol>
<li>Locate the <code>machine.config</code> file. Refer to the [[Machine.config]] article for instructions on locating it.</li>
<li>Once found, make a backup of the file and put it in a safe location.</li>
<li>Open the original file in a text editor and search for <code><DbProviderFactories></code>. This text should appear more than once.</li>
<li>Compare your file to the block of text below. If the file contains text that matches this, delete the text.
<syntaxhighlight lang="xml" enclose="div">
<system.data>
<DbProviderFactories>
<add name="IBM DB2 for i5/OS .NET Provider" invariant="IBM.Data.DB2.iSeries" description=".NET Framework Data Provider for i5/OS" type="IBM.Data.DB2.iSeries.iDB2Factory, IBM.Data.DB2.iSeries, Version=12.0.0.0, Culture=neutral, PublicKeyToken=9cdb2ebfb1f93a26" />
</DbProviderFactories>
</system.data>
</syntaxhighlight></li>
<li>Ensure that the file is saved before exiting the text editor.</li>
<li>The issue should now be resolved.</li>
</ol>

<div style="clear: both"></div>

== Event Log Errors ==
[[File:Order-Express-Has-Stopped-Working.png|thumbnail|Error Dialog]]
Order Express may occasionally crash without allowing the user to describe and submit the error to the support team.

When this occurs, the user will need to retrieve the log files and submit them manually.
=== Instructions ===

<ol>

<li> Press the "Windows" key, or click the "Start" button in the bottom-left corner of the screen.<br />
[[File:Windows-key.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
Once on the Start screen, type the text <code>Event Logs</code>. A search box should display as you begin typing.<br />
Wait for the search results to appear.<br />
Click the top entry, which should read <code>View event logs</code>.<br />
[[File:Search-event-logs-windows8.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
In the window that appears, click the arrow to the left of <code>Windows Logs</code><br />
[[File:Event-logs-default.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
Select the <code>Application</code> entry.<br />
[[File:Event-logs-windows.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
In the list shown in the middle of the window, locate the most recent entry that meets the following criteria:
<ul>
<li>It uses the <code>Error</code> Icon: [[File:Event-logs-error-icon.png]]</li>
<li>The <code>Source</code> column should contain <code>.NET Runtime</code></li>
</ul>
<div style="clear: both"></div>
<br />
</li>

<li>
Right-click on that entry, select <code>Copy</code>, and then select <code>Copy Details as Text</code>.<br />
[[File:Event-logs-dot-net-runtime-copy.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
At this point, the contents of the error log are on your clipboard, and can be pasted into any text editor.
</li>

<li>
Open a text editor (such as Notepad), and use the <code>Paste</code> command to insert the error details.
</li>

<li>
Save the text document, and attach it to an email to our support team.
</li>

</ol>

[[Category:Order Express]]

Order Express - Advanced Troubleshooting

2016-03-02T15:22:02Z

Gwilliams: /* Duplicate DbProviderFactories */

__FORCETOC__

== Standalone Version ==
[[File:OrderExpressStandaloneDownload.png|thumbnail|Standalone Version Download]]
[[File:OrderExpressStandaloneExexecutable.png|thumbnail|Locating the Executable]]
In order to debug certain issues, eVision Support may provide you with a link to download a ''Standalone Version'' of Order Express. This version of Order Express does not require installation and is primarily used to identify whether an issue is caused by a broken installation, or with Order Express directly.

<ol>
<li>Open the link that was provided to you by eVision Support</li>
<li>Click the ''Download'' button on the page and save the file to your desktop</li>
<li>Extract the downloaded file to a folder. (Note: Ensure the file is not marked as "Blocked" before you perform the extraction.)</li>
<li>Open the folder and locate the executable file for the application</li>
<li>If the program loads up successfully, the issue is the result of the installation routine. Perform the ''Extended (Full) Uninstall'' on the [[Uninstalling_Order_Express|Uninstalling Order Express]] page.</li>
<li>If the program does '''not''' load successfully, the cause of the issue is within the application.</li>
<li>Ensure that you communicate the results of this test back to eVision Support for additional troubleshooting steps.</li>
</ol>

<div style="clear: both"></div>
== Standalone Version Will Not Connect ==
[[File:OrderExpress_Standalone_Unblock1.png|thumbnail|Opening the "Properties" window]]
[[File:OrderExpress_Standalone_Unblock2.png|thumbnail|Unblocking the file]]
There exists a security feature within Windows that can sometimes prevent Standalone Versions of Order Express from working correctly. Files that are downloaded from an non-trusted web location are marked as "Blocked" by default, preventing them from retrieving content from the internet. The solution for this issue is to "unblock" the downloaded file.

<ol>
<li>Right-click on the file that was downloaded from the internet.</li>
<li>Select <code>Properties</code> from the context menu.</li>
<li>Find the <code>Unblock</code> button at the bottom of the dialog, and click it.</li>
<li>The file can now be opened. If the file is a zip file, it can now be extracted.</li>
</ol>

'''Note:''' If the blocked file is a zip file, it ''must'' be unblocked prior to extracting it, or you will likely encounter issues with the unzipped files.

<div style="clear: both"></div>
== Duplicate DbProviderFactories ==

Due to an issue in certain software, you may receive the following error:
<code>The 'DbProviderFactories' section can only appear once per config file.</code>

This occurs because the [[Machine.config]] file on the computer contains erroneous information and must be fixed by hand.

<ol>
<li>Locate the <code>machine.config</code> file. Refer to the [[Machine.config]] article for instructions on locating it.</li>
<li>Once found, make a backup of the file and put it in a safe location.</li>
<li>Open the original file in a text editor and search for <code><DbProviderFactories></code>. This text should appear more than once.</li>
<li>Compare my file to the block of text below. If the file contains text that matches this, delete the text.
<syntaxhighlight lang="xml" enclose="div">
<system.data>
<DbProviderFactories>
<add name="IBM DB2 for i5/OS .NET Provider" invariant="IBM.Data.DB2.iSeries" description=".NET Framework Data Provider for i5/OS" type="IBM.Data.DB2.iSeries.iDB2Factory, IBM.Data.DB2.iSeries, Version=12.0.0.0, Culture=neutral, PublicKeyToken=9cdb2ebfb1f93a26" />
</DbProviderFactories>
</system.data>
</syntaxhighlight></li>
<li>Ensure that the file is saved before exiting the text editor.</li>
<li>The issue should now be resolved.</li>
</ol>

<div style="clear: both"></div>

== Event Log Errors ==
[[File:Order-Express-Has-Stopped-Working.png|thumbnail|Error Dialog]]
Order Express may occasionally crash without allowing the user to describe and submit the error to the support team.

When this occurs, the user will need to retrieve the log files and submit them manually.
=== Instructions ===

<ol>

<li> Press the "Windows" key, or click the "Start" button in the bottom-left corner of the screen.<br />
[[File:Windows-key.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
Once on the Start screen, type the text <code>Event Logs</code>. A search box should display as you begin typing.<br />
Wait for the search results to appear.<br />
Click the top entry, which should read <code>View event logs</code>.<br />
[[File:Search-event-logs-windows8.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
In the window that appears, click the arrow to the left of <code>Windows Logs</code><br />
[[File:Event-logs-default.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
Select the <code>Application</code> entry.<br />
[[File:Event-logs-windows.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
In the list shown in the middle of the window, locate the most recent entry that meets the following criteria:
<ul>
<li>It uses the <code>Error</code> Icon: [[File:Event-logs-error-icon.png]]</li>
<li>The <code>Source</code> column should contain <code>.NET Runtime</code></li>
</ul>
<div style="clear: both"></div>
<br />
</li>

<li>
Right-click on that entry, select <code>Copy</code>, and then select <code>Copy Details as Text</code>.<br />
[[File:Event-logs-dot-net-runtime-copy.png|border|left]]
<div style="clear: both"></div>
<br />
</li>

<li>
At this point, the contents of the error log are on your clipboard, and can be pasted into any text editor.
</li>

<li>
Open a text editor (such as Notepad), and use the <code>Paste</code> command to insert the error details.
</li>

<li>
Save the text document, and attach it to an email to our support team.
</li>

</ol>

[[Category:Order Express]]

Order Express Formulas

2016-03-01T16:20:48Z

Gwilliams: /* Specials */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). When evaluating <code>StyleOptionRules</code>, will return true if any of the currently selected style options is a special.

==== Special Product ====

Tokens: <code>A:P:</code> or <code>Special:Product:</code>

Format: <code>A:P:?</code>

The format <code>A:P:?</code> is the equivalent of asking if the current item being evaluated is a special product.

==== Special Modification ====

Tokens: <code>A:P:</code> or <code>Special:Modification:</code>

Format: <code>A:D:?</code>

The format <code>A:D:?</code> is the equivalent of asking if the current item being evaluated is a special modification.

==== Special Style Options for a Given Category ====

Tokens: <code>S: and A:</code> or <code>StyleOption: and Special:</code>

Format: <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>

To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-03-01T16:11:08Z

Gwilliams: /* Specials */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code> or <code>A:[token]</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. This includes special products and special modifications (and styles). To detect a specific type of special, use the format <code>A:[token]</code>, where <code>[token]</code> is one of the following: <code>P:?</code> for special products; <code>D:?</code> for special modifications. When evaluating <code>StyleOptionRules</code>, it will return true if any of the currently selected style options is a special. To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-03-01T16:08:03Z

Gwilliams: /* Specials */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code> or <code>A:[atom]</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. When evaluating <code>StyleOptionRules</code>, it will return true if any of the currently selected style options is a special. To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>

Order Express Formulas

2016-03-01T16:06:59Z

Gwilliams: /* Products */

== Overview ==

[[Order Express]] utilizes a robust expression system designed by [[eVision Services]] which allows for the conditional availability and pricing and of items. These ''formulas'' are stored within the database in the <code>Formulas</code>, <code>PricingRules</code>, <code>FinalValidationRules</code> and <code>StyleOptionRules</code> table. Formulas are primarily written in [[wikipedia:Reverse Polish Notation|postfix notation]], but include a number of keywords that can be used to retrieve information about the item being evaluated or priced (such as how a product can be priced differently based on which styles are applied to it).

== Valid Tokens ==

These keywords are considered to be "valid" keywords/tokens within the ''Rules Engine''. Each of the keywords are shown as links which will take you to their usage instructions.

* <code>A:</code> - [[#Specials|Special]]
* <code>ACCOUNT:</code> - [[#Accounts|Account]]
* <code>ACCOUNTVARIABLE:</code> - [[#Account_Variables|Account Variable]]
* <code>C:</code> - [[#Product_and_Modification_Categories|Category]]
* <code>COUNT:</code> - [[#Count|Count]]
* <code>D:</code> - [[#Modifications|Modification]]
* <code>E:</code> - [[#Finished_End_Option_Groups|Finished End Option Group]]
* <code>EVERY:</code> - [[#Every_Condition|Every]]
* <code>F:</code> - [[#Nested_Formulas|Formula]]
* <code>H:</code> - [[#Hinging_Option_Groups|Hinging Option Group]]
* <code>I:</code>, <code>=></code>, and <code>,</code> - [[#Conditional_Expressions|Conditional]]
* <code>IF:</code> and <code>=></code> - [[#Infix_Conditional_Expressions|Infix Conditional]]
* <code>INFIX:</code> - [[#Infix_Expressions|Infix]]
* <code>L:</code> - [[#Product_Lines|Product Line]]
* <code>LIMIT:</code> - [[#Limits|Limit]]
* <code>M:</code> - [[#Variable_Price_Codes|Variable Price Code]]
* <code>MAX:</code> - [[#Maximum_Value|Max]]
* <code>MIN:</code> - [[#Minimum_Value|Min]]
* <code>N:</code> - [[#Style_Option_Selection_Count|Style Option Selection Count]]
* <code>O:</code> - [[#Style_Options|Style Option]]
* <code>P:</code> - [[#Products|Product]]
* <code>Q:</code> - [[#Style_Option_Selections|Style Option Selection]]
* <code>QUOTE:</code> - [[#Quotes|Quote]]
* <code>QUOTEVARIABLE:</code> - [[#Quote_Variables|Quote Variable]]
* <code>R:</code> - [[#Prices|Price]]
* <code>S:</code> - [[#Style_Option_Categories|Style Option Category]]
* <code>SOME:</code> - [[#Some_Conditions|Some]]
* <code>SUM:</code> - [[#Summation|Sum]]
* <code>T:</code> - [[#Tags|Tag]]
* <code>U:</code> - [[#Upcharges|Upcharge]]
* <code>V:</code> - [[#Product_Variables|Variable]]
* <code>VAR:</code> - [[#Context_Variables|Context Variable]]
* <code>W:</code> - [[#Modification_Variables|Modification Variable]]
* <code>X:</code> - [[#Constants|Constant]]
* <code>Z:</code> - Evaluation

== Usage ==

=== Accounts ===

Tokens: <code>ACCOUNT:</code>

Format: <code>ACCOUNT:[property_or_variable_code]</code>

Used to obtain the value of a account variable or property for the account the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Account</code> object.

=== Aggregation ===

Tokens: <code>COUNT:()</code>, <code>MAX:()</code>, <code>MIN:()</code>, <code>SUM:()</code>

==== Count ====

Tokens: <code>COUNT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>COUNT:([atoms])</code> or <code>COUNT:[count_greater_or_equal_to]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns the number <code>[atoms]</code> that return true. The value of <code>[count_greater_or_equal_to]</code> changes the return type of this atom into a boolean, where the result is true if the number of <code>[atoms]</code> is greater or equal to the value supplied.

==== Maximum Value ====

Tokens: <code>MAX:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MAX:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the largest value.

==== Minimum Value ====

Tokens: <code>MIN:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>MIN:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms of which to find the smallest value.

==== Summation ====

Tokens: <code>SUM:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SUM:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to add together.

=== Categories ===

Tokens: <code>C:</code>, <code>S:</code>

==== Product and Modification Categories ====

Tokens: <code>C:</code> or <code>Category:</code>

Format: <code>C:[product_category_display_id]</code> or <code>C:[modification_category_display_id]</code>

The value for the <code>[product_category_display_id]</code> parameter should match the <code>ProductCategoryDisplayID</code> in the <code>ProductCategories</code> table. The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table.

==== Style Option Categories ====

Tokens: <code>S:</code> or <code>StyleOptionCategory:</code>

Format: <code>S:[style_option_category_display_id]</code> or <code>S:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>ShortName</code> in the <code>StyleOptionCategories</code> table. The boolean value indicating whether there is a selected style option category excludes special style options.

=== Conditionals ===

Tokens: <code>EVERY:</code>, <code>I:</code>, <code>LIMIT:</code>, <code>SOME:</code>

==== Every Condition ====

Tokens: <code>EVERY:</code> or <code>ALL:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>EVERY:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if all of the atoms test true.

==== Conditional Expressions ====

Tokens: <code>I:</code> or <code>Conditional:</code>, <code>=></code>, <code>,</code>

Format: <code>I:[conditional]=>[expression_if_true],[expression_if_false]</code>

Conditional expressions are defined using the above tokens. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed. If it evaluates to <code>false</code>, the <code>[expression_if_false]</code> parameter is executed. Atoms that use the <code>TOKEN:(,)</code> format are not supported in the true or false expressions; they are however, supported in [[#Infix_Conditional_Expressions|infix conditionals]].

==== Limits ====

Tokens: <code>LIMIT:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>LIMIT:([atoms])</code> or <code>LIMIT:[maximum]([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. The value of <code>[maximum]</code> indicates the threshold at which the result will be true (greater than <code>[maximum]</code>). If no <code>[maximum]</code> is supplied, it is assumed <code>0</code>.

==== Some Conditions ====

Tokens: <code>SOME:</code> or <code>ANY:</code>, <code>(</code>, <code>,</code>, <code>)</code>

Format: <code>SOME:([atoms])</code>

The value for <code>[atoms]</code> is a comma separated list of atoms to test against. Returns true if any of the atoms test true.

=== Constants ===

Tokens: <code>X:</code> or <code>Constant:</code>

Format: <code>X:[constant_name]</code>

Used to obtain the value of constant. The value for the <code>[constant_name]</code> parameter must match the <code>ShortName</code> column in the <code>Constants</code> table.

==== Boolean ====

Tokens: None

Format: <code>[boolean]</code>

The value must be a string representation of a boolean. Valid values are <code>true</code> or <code>false</code> (case-insensitive).

==== Decimal ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:[decimal]</code> or <code>[decimal]</code>

The value must be a string representation of a number.

==== String ====

Tokens: <code>X:</code>, <code>Constant:</code> or None

Format: <code>X:"[string]"</code> or <code>"[string]"</code>

The value can be any string (enclosed in double quotes).

=== Infix Notation ===

Tokens: <code>INFIX:</code>, <code>IF:</code>

==== Infix Expressions ====

Tokens: <code>INFIX:</code> or <code>MATH:</code> or <code>=</code>

Format: <code>INFIX:[expression]</code>

The value for <code>[expression]</code> is an expression/formula written in [[wikipedia:Infix notation|infix notation]]. Uses a subset of the [[#Valid_Operators|available operators]]: <code>*</code>, <code>/</code>, <code>+</code>, <code>-</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>/U</code>, <code>*U</code>, <code>&&</code>, <code>||</code>, <code>!=</code>, <code>^</code>, <code>%</code>, <code>==</code>, <code>??</code>. When using the <code>=</code> token to denote an infix expression, it must be the first character in the formula.

==== Infix Conditional Expressions ====

Tokens: <code>IF:</code> or <code>InfixConditional:</code> or <code>ELSEIF:</code>, <code>=></code> or <code>THEN:</code> or <code>ELSE:</code>

Format: <code>IF:[conditional]</code> or <code>IF:[conditional]=>[expression_if_true]</code> or <code>IF:[conditional]=>[expression_if_true]=>[expression_if_false]</code> or

<code>IF:[conditional]THEN:[expression_if_true]ELSEIF:[second_conditional]THEN:[expression_if_second_is_true]ELSE:[expression_if_all_are_false]</code>

Infix conditional expressions are defined using the above tokens, and as the name suggests, uses [[wikipedia:Infix notation|infix notation]] throughout. When these tokens are found within the expression, the expression is split into multiple ''parts''. The <code>[conditional]</code> parameter is ''always'' executed to determine if it evaluates to a <code>true</code> or <code>false</code> value. If this evaluates to <code>true</code>, the <code>[expression_if_true]</code> parameter is executed (or if <code>[expression_if_true]</code> is omitted, <code>1</code> when pricing, otherwise <code>true</code>). If it evaluates to <code>false</code> and <code>[expression_if_false]</code> is omitted, <code>0</code> is returned when pricing, otherwise <code>false</code>; the <code>[expression_if_false]</code> parameter is executed if supplied. The conditionals can be chained by using an <code>ELSEIF:</code> in the false expression.

=== Modifications ===

Tokens: <code>D:</code> or <code>Modification:</code>

Format: <code>D:[modification_display_id]</code> or <code>D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. If the current item being evaluated is a modification, the value returned will be true if the modification's display id matches. If the current item being evaluated is a product, the value returned will be true if the product has a modification attached to it where the modification's display id matches. The format <code>D:?</code> is the equivalent of asking if the current item being evaluated is a modification. To check for special modifications, use <code>A:D:?</code>.

==== Modification Product ====

Tokens: <code>D:P:</code>, <code>D:P:D:</code>, <code>Modification:Product:</code> or <code>Modification:Product:Modification</code>

Format: <code>D:P:[product_display_id]</code> or <code>D:P:D:[modification_display_id]</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The value returned will be true if the modification being evaluated is attached to a product with a matching display id. The format <code>D:P:D:[modification_display_id]</code> is the equivalent of asking if the modification that is being evaluated is attached to a product that with a matching modification display id.

==== Modification Product Tags ====

Tokens: <code>D:P:T:</code> or <code>Modification:Product:Tag:</code>

Format: <code>D:P:T:[tag_name]</code>

Used to determine if the modification is attached to a product that is tagged as the value specified in the <code>[tag_name]</code> parameter.

==== Modification Product Categories ====

Tokens: <code>D:P:C:</code> or <code>Modification:Product:Category:</code>

Format: <code>D:P:C:[product_category_display_id]</code>

Used to determine if the modification is attached to a product that is included in the category as specified by the value of the <code>[product_category_display_id]</code> parameter.

=== Nested Formulas ===

Tokens: <code>F:</code> or <code>Formula:</code>

Format: <code>F:[parameter]</code>

Executes the pricing rule with a name of <code>[parameter]</code>. This is primarily used in conjunction with the conditional operators, or to split expressions into shorter pieces.

The value for <code>[parameter]</code> should match <code>PricingRuleLabel</code>.

=== Pricing and Upcharges ===

Tokens: <code>R:</code>, <code>U:</code>, <code>M:</code>

==== Prices ====

Tokens: <code>R:</code> or <code>Price:</code>

Format: <code>R:[price_type]</code> or <code>R:[pricing_rule_label]</code>

Used to obtain the price for the current item. Only four values are valid for the <code>[price_type]</code> parameter. These values are <code>BOOK</code>, <code>LIST</code>, <code>PREMIUM</code> or <code>BASE</code>. <code>BOOK</code> is the calculation of the first summary group in the sequence (<code>ProductLineSummaryGroups</code>), where as <code>LIST</code> is the price with no formula applied. If <code>[pricing_rule_label]</code> is supplied, it executes the pricing rule with a name of <code>[pricing_rule_label]</code>. The value for <code>[pricing_rule_label]</code> should match <code>PricingRuleLabel</code>.

==== Upcharges ====

Tokens: <code>U:</code> or <code>Upcharge:</code>

Format: <code>U:[style_option_category_short_name]</code>

Used to obtain the price of an upcharge for the style option category that matches the <code>[style_option_category_short_name]</code> parameter for the current item. The value for the <code>[style_option_category_short_name]</code> must match the <code>ShortName</code> column in the <code>StyleOptionCategories</code> table.

==== Variable Price Codes ====

Tokens: <code>M:</code> or <code>VariablePriceCode:</code>

Format: <code>M:[variable_code]</code>

Used to obtain the price for the current item. The value specified for the <code>[variable_code]</code> parameter is used, alongside the current price group, to obtain the price for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>Code</code> column in the <code>OEVariablePriceCodes</code> table.

=== Products ===

Tokens: <code>P:</code> or <code>Product:</code>

Format: <code>P:[product_display_id]</code> or <code>P:?</code>

The value for the <code>[product_display_id]</code> parameter should match the <code>ProductDisplayID</code> in the <code>Products</code> table. The format <code>P:?</code> is the equivalent of asking if the current item being evaluated is a product. To check for special products, use <code>A:P:?</code>.

==== Product Modifications ====

Tokens: <code>P:D:</code> or <code>Product:Modification:</code>

Format: <code>P:D:[modification_display_id]</code> or <code>P:D:?</code>

The value for the <code>[modification_display_id]</code> parameter should match the <code>ModificationDisplayID</code> in the <code>Modifications</code> table. The value returned will be true if the product being evaluated has a modification attached to it where the modification's display id matches. The format <code>P:D:?</code> is the equivalent of asking if the current product has any modifications attached to it.

==== Product Modification Categories ====

Tokens: <code>P:D:C:</code> or <code>Product:Modification:Category:</code>

Format: <code>P:D:C:[modification_category_display_id]</code>

The value for the <code>[modification_category_display_id]</code> parameter should match the <code>ModificationCategoryDisplayID</code> in the <code>ModificationCategories</code> table. Returns true of the product being evaluated has any modifications attached to it which match the specified modification category.

=== Product Lines and Options ===

Tokens: <code>E:</code>, <code>H:</code>, <code>L:</code>

==== Finished End Option Groups ====

Tokens: <code>E:</code> or <code>FinishedEndOptionGroup:</code>

Format: <code>E:[finished_end_group_option_code]</code>

The value for the <code>[finished_end_group_option_code]</code> parameter should match the <code>FinishedEndOptionGroupCode</code> in the <code>FinishedEndOptionGroups</code> table.

==== Hinging Option Groups ====

Tokens: <code>H:</code> or <code>HingingOptionGroup:</code>

Format: <code>H:[hinging_option_group_code]</code>

The value for the <code>[hinging_option_group_code]</code> parameter should match the <code>HingingOptionGroupCode</code> in the <code>HingingOptionGroups</code> table.

==== Product Lines ====

Tokens: <code>L:</code> or <code>ProductLine:</code>

Format: <code>L:[product_line_name]</code>

The value for the <code>[product_line_name]</code> parameter should match the <code>LineName</code> in the <code>ProductLines</code> table.

=== Quotes ===

Tokens: <code>QUOTE:</code>

Format: <code>QUOTE:[property_or_variable_code]</code>

Used to obtain the value of a quote variable or property for the quote the current item is associated with. The value for the <code>[property_or_variable_code]</code> parameter must match either the <code>VariableCode</code> column in the <code>OEVariables</code> table or a property on the <code>Quote</code> object.

=== Specials ===

Tokens: <code>A:</code> or <code>Special:</code>

Format: <code>A:?</code>

The format <code>A:?</code> is the equivalent of asking if the current item being evaluated is a special. When evaluating <code>StyleOptionRules</code>, it will return true if any of the currently selected style options is a special. To check if a special style option is selected for a given category, use the format <code>S:[style_option_category_display_id]:A:?</code> or <code>S:[style_option_category_name]:A:?</code>.

=== Style Options and Selections ===

Tokens: <code>O:</code>, <code>Q:</code>, <code>N:</code>

==== Style Options ====

Tokens: <code>O:</code> or <code>StyleOption:</code>

Format: <code>O:[style_option_display_id]</code> or <code>O:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table.

==== Style Option Selections ====

Tokens: <code>Q:</code> or <code>StyleOptionSelection:</code>

Format: <code>Q:[style_option_display_id]</code> or <code>Q:[style_option_tag_name]</code>

The value for the <code>[style_option_display_id]</code> parameter should match the <code>StyleOptionDisplayID</code> in the <code>StyleOptions</code> table. The value of <code>[style_option_tag_name]</code> should match the <code>StyleOptionTag</code> in the <code>StyleOptionTags</code> table. Functionally equivalent to the <code>O:</code> token, with the exception of when evaluating Style Option Rules, will check all products on the quote for the selected style.

==== Style Option Selection Count ====

Tokens: <code>N:</code> or <code>StyleOptionSelectionCount:</code>

Format: <code>N:[style_option_category_display_id]</code> or <code>N:[style_option_category_name]</code>

The value for the <code>[style_option_category_display_id]</code> parameter should match the <code>StyleOptionCategoryDisplayID</code> in the <code>StyleOptionCategories</code> table. The value of <code>[style_option_category_name]</code> should match the <code>Name</code> in the <code>StyleOptionCategories</code> table.

=== Tags ===

Tokens: <code>T:</code> or <code>Tag:</code>

Format: <code>T:[tag_name]</code>

Used to determine if the current item is tagged as the value specified in the <code>[tag_name]</code> parameter. When the formula is being used as a price rule for a modification, the check is made on the product the modification is attached to (the equivalent of <code>D:P:T:[tag_name]</code>).

=== Variables ===

Tokens: <code>ACCOUNTVARIABLE:</code>, <code>VAR:</code>, <code>V:</code>, <code>W:</code>, <code>QUOTEVARIABLE:</code>

==== Account Variables ====

Tokens: <code>ACCOUNTVARIABLE:</code>

Format: <code>ACCOUNTVARIABLE:[variable_code]</code>

Used to obtain the value of a account variable for the account the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Context Variables ====

Tokens: <code>VAR:</code> or <code>ContextVariable:</code>

Format: <code>VAR:[variable_name]</code> or <code>[variable_name]</code> or <code>VAR:[variable_name]=[variable_value];[expression]</code> or

<code>VAR:[variable_name]=[variable_value];[second_variable_name]=[second_variable_value];[expression]</code>

Used to get or set the value of a variable during formula evaluation. The value for the <code>[variable_name]</code> can be any valid variable name (a-zA-Z0-9). The value for <code>[variable_value]</code> can be any valid formula. If a variable has not first been set, when evaluating a quote product this functions the same as [[#Product_Variables|product variables]]; similarly, when evaluating a quote product modification, this functions the same as [[#Modification_Variables|modification variables]].

==== Product Variables ====

Tokens: <code>V:</code> or <code>Variable:</code>

Format: <code>V:[variable_code]</code>

Used to obtain the value of a product variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

==== Modification Variables ====

Tokens: <code>W:</code> or <code>ModificationVariable:</code>

Format: <code>W:[variable_code]</code>

Used to obtain the value of a modification variable for the current item. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table. When pricing a quote product modification, the value is first checked against any <code>ModificationPrompts</code> with a matching <code>OEVariable</code>.

==== Quote Variables ====

Tokens: <code>QUOTEVARIABLE:</code>

Format: <code>QUOTEVARIABLE:[variable_code]</code>

Used to obtain the value of a quote variable for the quote the current item is associated with. The value for the <code>[variable_code]</code> parameter must match the <code>VariableCode</code> column in the <code>OEVariables</code> table.

== Rules and Formulas ==

=== Formulas ===

Located in the <code>Formulas</code> table. Used to validate the availability of modifications, finished ends, hinging, and so on. The <code>F:</code> token uses the <code>Formulas</code> table. In the case of validating modification availability, return true if the modification is available.

=== Final Validation Rules ===

Located in the <code>FinalValidationRules</code> table. Used to validate a quote before its status is changed to ''submitted''. The <code>F:</code> token uses the <code>Formulas</code> table. The rule should return false if the validation fails and a message needs to be presented to the user.

=== Pricing Rules ===

Located in the <code>PricingRules</code> table. Used to calculate pricing. The <code>F:</code> token uses the <code>PricingRules</code> table.

=== Style Option Rules ===

Located in the <code>StyleOptionRules</code> table. Used in evaluating the availability of style options.

==== Excludes ====

Tokens: <code><X></code>

Format: <code>[atoms]~<X>~[excluded_atoms]</code>

If any <code>[atoms]</code> are selected, <code>[excluded_atoms]</code> are excluded. The inverse is also true, if any <code>[excluded_atoms]</code> are matched, <code>[atoms]</code> are excluded. Valid atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>.

==== Excludes X of Y ====

Tokens: <code>< ></code>

Format: <code>[atoms]~<[count]>~[additional_atoms]</code>

If <code>[count]</code> or more <code>[atoms]</code> and or <code>[additional_atoms]</code> are selected, <code>[atoms]</code> and <code>[additional_atoms]</code> are excluded. Valid atoms start with <code>T:</code>.

==== Formula ====

Tokens: <code><F></code>

Format: <code>[style_selection_atoms]~<F>~[formula]</code>

If <code>[formula]</code> evaluates to true, <code>[style_selection_atoms]</code> are excluded. Valid style selection atoms start with <code>T:</code>, <code>O:</code>, <code>S:</code> or <code>Q:</code>. The <code>[formula]</code> can use all tokens. The <code>F:</code> token uses the <code>Formulas</code> table.

=== Values (Min, Max, Effect Conditions) ===

Usable in <code>OEPromptItems</code> and <code>ModificationPrompts</code>: <code>MinValue</code>, <code>MaxValue</code>, <code>MinFractionalValue</code>; <code>ModificationVariableEffects</code>: <code>Value</code>, <code>EffectConditionFormulaID</code>, <code>EffectType</code>. If the <code>EffectType</code> is a modification (e.x.: <code>D:123</code>), and the user is on advanced product entry with auto-mods enabled, the specified modification will automatically be selected. The <code>F:</code> token uses the <code>Formulas</code> table.

== Result Negation ==

To negate the result of an ''operation'' append a <code>!</code> after the token and before the token value. This works for both boolean and decimal results. In the case of a decimal, this is the equivalent of multiplying by <code>-1</code>.

== Valid Operators ==

=== String ===

<code>+</code> - Concatenate

<code>=</code> - Case Insensitive Equality

<code>==</code> - Case Sensitive Equality

<code>!</code> - Case Insensitive Inequality

<code>!=</code> - Case Sensitive Inequality

<code><</code> - Ordinal Less Than

<code>></code> - Ordinal Greater Than

<code><=</code> - Ordinal Less Than or Equal To

<code>>=</code> - Ordinal Greater Than or Equal To

<code>??</code> - Second Value if First is Null

=== Number (Decimal) ===

<code>+</code> - Add

<code>-</code> - Subtract

<code>*</code> - Multiply

<code>/</code> - Divide

<code>^</code> - Exponential

<code>%</code> - Modulo

<code>*U</code> - Multiply and Apply Ceiling on the Product

<code>/U</code> - Divide and apply Ceiling on the Quotient

<code><</code> - Less Than

<code>></code> - Greater Than

<code><=</code> - Less than or Equal To

<code>>=</code> - Greater Than or Equal To

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>|</code> or <code>||</code> - Either Value is Greater Than Zero

<code>&</code> or <code>&&</code> - Both Values are Greater Than Zero

<code>??</code> - Second Value if First is Less Than or Equal To Zero

=== Boolean ===

<code>|</code>, <code>||</code>, <code>-</code>, <code>/</code>, <code>%</code> or <code>??</code> - Either Value is True

<code>&</code>, <code>&&</code>, <code>+</code>, <code>*</code> or <code>^</code> - Both Values are True

<code>=</code> or <code>==</code> - Equality

<code>!</code> or <code>!=</code> - Inequality

<code>#</code> - Logical Not (One True Value and One False Value)

== Examples ==

=== Aggregate Atoms ===

<code>COUNT:(O:12,O:34,O:56)</code> - Returns the number of style options that match

<code>COUNT:2(O:78,O:99,O:100)</code> - Returns true if two or more of the style options match

<code>MAX:(V:MIN_CHARGE,F:PRICE_PER_SQ_FEET_WxD)</code> - Returns <code>F:PRICE_PER_SQ_FEET_WxD</code> if it is greater than <code>V:MIN_CHARGE</code>, otherwise returns <code>V:MIN_CHARGE</code>

<code>SUM:(R:LIST,F:FINISHED_END_UPCHARGE)</code> - Returns the sum of list price and <code>F:FINISHED_END_UPCHARGE</code>. Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>SUM:(R:LIST,F:!DISCOUNT)</code> - Returns the list price minus the discount (adds the negated result of the DISCOUNT formula)

=== Conditional Atoms ===

<code>LIMIT:1(O:123,O:456,O:789)</code> - Returns true if more than one style option matches

<code>ANY:(T:IsTall,T:IsTallCorner)</code> - Returns true if an item is tagged with IsTall or IsTallCorner. Same as <code>SOME:(T:IsTall,T:IsTallCorner)</code> or <code>T:IsTall~T:IsTallCorner~|</code>

<code>ALL:(T:IsBase,O:Framed,O:Cherry)</code> - Returns true if the product is tagged IsBase and it has style option selections that are tagged Framed and Cherry

=== Math and Infix Atoms ===

<code>MATH:1+2*3/(4+5)</code> - Returns the numeric value <code>1.666...</code>

<code>=2+4*8/(10+22)</code> - Returns the numeric value <code>3</code>

<code>=-2+4-2*-2</code> - Returns the numeric value <code>6</code>

<code>INFIX:R:LIST+F:FINISHED_END_UPCHARGE</code> - Same as <code>R:LIST~F:FINISHED_END_UPCHARGE~+</code>

<code>IF: V:ROS_H <= 9.6875 => R:BOOK => R:BOOK * 2</code> - Same as <code>I:V:ROS_H~X:NINE_DOT_SIXEIGHTSEVENFIVE~<==>R:BOOK,R:BOOK~X:TWO~*</code>

<code>IF: V:ROS_H <= 9.6875 THEN: R:BOOK ELSEIF: V:ROS_H > 20 THEN: R:BOOK * 3 ELSE: R:BOOK * 2</code> -
:Logically the same as <code>if (V:ROS_H <= 9.6875) { return R:BOOK; } if (V:ROS_H > 20) { return R:BOOK * 3; } return R:BOOK * 2;</code>

<code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code> -
:Same as <code>I:P:?~V:FINISH_UPCHARGE~&~D:?~W:FINISH_UPCHARGE~&~A:?~|~|=>F:UPCHARGE,X:ZERO</code>

<code>=F:LIST_PREMIUM * SUM:(U:CarriageHouseVintage,U:WornEdgeTreatmentVintage,U:FlyspeckSplitsVintage,U:DistressingWormholesVintage,U:KnifeOutsVintage,U:JointCutsVintage)</code> -
:Same as <code>U:CarriageHouseVintage~U:WornEdgeTreatmentVintage~+~U:FlyspeckSplitsVintage~+~U:DistressingWormholesVintage~+~U:KnifeOutsVintage~+~U:JointCutsVintage~+~F:LIST_PREMIUM~*</code>

=== Context Variable Atom ===

<code>var: x = 10; y = 5; z = x * y; x + y + z</code> - Returns the numeric value <code>65</code>

<code>IF: ANY:(VAR:WS_UPCHARGE,A:?) => F:UPCHARGE</code> - Same as <code>IF: (P:? && V:WS_UPCHARGE) || (D:? && W:WS_UPCHARGE) || A:? => F:UPCHARGE</code>

<code>var: u = U:FINISH; IF: u < .1 THEN: 173 ELSEIF: u < .2 THEN: 217 ELSEIF: u < .3 THEN: 269 ELSEIF: u < .4 THEN: 329 ELSEIF: u < .5 THEN: 398 ELSEIF: u < .6 THEN: 476 ELSE: 563</code> -
:Same as <code>IF: U:FINISH < .1 THEN: 173 ELSEIF: U:FINISH < .2 THEN: 217 ELSEIF: U:FINISH < .3 THEN: 269 ELSEIF: U:FINISH < .4 THEN: 329 ELSEIF: U:FINISH < .5 THEN: 398 ELSEIF: U:FINISH < .6 THEN: 476 ELSE: 563</code>

=== Negation ===

<code>I:P:7206=>F:!PRODBSD6FinalValidationRule,TRUE</code> - Same as <code>I:P:7206=>F:PRODBSD6FinalValidationRule~X:TRUE~#,X:TRUE</code>

<code>T:!IsMolding</code> - Returns true if an item is not tagged with IsMolding

<code>=! true</code> - Returns false

=== Style Option Formulas ===

<code>T:KK~<F>~AccountVariable:NOT_FOR_KK</code> - Exclude KK if the account has a true value for the variable NOT_FOR_KK

<code>T:Cabinet Order~<F>~IF: Quote:ProjectUrgency.ProjectUrgencyLabel != "Cabinet Order"</code> -
:Exclude style options tagged Cabinet Order if the order type Cabinet Order is not selected.

=== Tokenless Constants ===

<code>I:V:EXTENDED_STILE_R~3~<==>92,114</code> - Same as <code>I:V:EXTENDED_STILE_R~X:THREE~<==>X:NINETYTWO,X:ONEHUNDREDFOURTEEN</code>