Using the Condition Editor

Use the Condition Editor to set a condition for a letter template, paragraph section, or paragraph. Conditions specify the criteria when an element (letter template, paragraph section, or paragraph) should be generated in rendered letters for the return configuration set. If no condition is set for an element, it will always be generated in rendered letters for the return configuration set. Letter template conditions are evaluated before paragraph conditions when letters are rendered.

Standard letter template and paragraph conditions cannot be displayed in the editor; however, you can override or append to the conditions by saving the standard template or paragraph as a custom.

Whether a paragraph is generated in rendered letters can depend on how the paragraph was created:

  • Custom paragraphs created from standard paragraphs. Custom paragraphs created from a standard paragraph include system conditions. You can append to the system conditions by adding conditions of your own. You also have the option of not including system conditions.
  • If you choose not to include system conditions, you must add a condition in the Condition Editor or the paragraph will never generate in rendered letters.
  • User-defined custom paragraphs. User-defined custom paragraphs do not include system conditions. You can add conditions if you want them to be generated in rendered letters according to the condition criteria. If you do not add a condition to user-defined custom paragraphs, they will always generate in rendered letters.

To manage custom conditions, do the following:

  1. Right-click a custom letter template, a custom paragraph in a template in the Word pane, or a custom paragraph in the Paragraph Library, and select Edit Condition from the menu. The Condition Editor displays. The tax year and return type are populated by Correspondence Manager and cannot be edited in the editor.
  2. Tip: The Edit Condition option is available only for custom letters and paragraphs. Custom letters are distinguished by the letter name. All standard letter templates include the word Standard in the name. Custom paragraphs in the Paragraph Library are color-coded as follows:

    • Pink text. Custom paragraph created from a standard paragraph
    • Blue text. User-defined custom paragraph, also referred to as pure custom paragraph

    See Adding Custom Letter Templates and Adding Custom Paragraphs for more information.

  3. Begin by dragging a keyword, form, or pre-built condition or expression from the left navigation panel to the Condition Builder grid. Click the up and down arrows to expand and collapse sections on the navigation panel.
  4. ClosedExplain the components in the left pane.

    1. In the Keywords section search box, enter a full name to display an exact match or a partial name to display all possible matches, and then click. A list of similar keywordsClosed Variable blocks of text in correspondence paragraphs that are defined by the system. Keywords are changed to return-specific data when letter templates are rendered in returns. displays.
    2. Select a keyword from the list.
    3. In the Forms section, select a tax authority from the list.
  5. Set the expression for the condition using the available operators and commands. The available operators depend on the type of keyword, form, and pre-built condition or expression entered in the grid row. You may need to enter a specific value or select a value from the Lookup Value window.
  6. ClosedExplain the components in the right pane.

  7. Click Save to save your changes. When you save your changes, the Cancel button changes to Close.
  8. Click Close to return to the Correspondence Manager window.

ClosedShow me an example of a previewed condition.

kwd["Miscellaneous"."Federal"."Main Electronic Filing"."Electronic Filing Flag"] = "Y" AND

(kwd["Miscellaneous"."Federal"."Estimate - Main Form"."Fed Estimate Vouchers Flag"] = "X" OR

kwd["Miscellaneous"."State"."State Estimates Present"] = "X")

  • Keyword Library path. The information within brackets shows the full path to the keyword in the Keyword Library. The last item in quotations within each pair of brackets is the keyword.
  • X and Y variables. The Y variable requires electronic filing to be selected. The X variable requires either federal estimate vouchers or state estimates to be present.
  • Parentheses and connectors. Parentheses group the last two lines of the condition. In this example, electronic filing must be selected AND because the last two lines are grouped, either federal estimate vouchers OR state estimates must be present.

You can edit conditions for custom paragraphs for all letter types except transmittal, extension, and K-1 letters. These letter types have internal conditions that do not display in the Condition Editor when saved as a custom. However, you can append conditions to custom paragraphs of these letter types.

Notes:

  • When editing a condition that uses a pre-built condition or expression that has been deleted, it displays in red font in the Condition Builder. You must remove the pre-built condition or expression that was deleted and make the edits necessary to correct the condition for the element (letter template, paragraph section, or paragraph).
  • A caution symbol,, displays when a condition line has an error. Hover over the symbol to display a message containing the reason for the error.