Skip to main content
Skip table of contents

Creating a Formula

Using a Formula Column, you can perform calculations or comparisons based on issue fields or other attributes, and display those results in a column for each visible row in the structure.

The following guide will walk you through how to create a formula in a formula column:

1. Enter your formula

Formulas should be constructed using the Expr Language, a simple language that supports variables, arithmetic operations, and functions. For a brief overview, see Expr Language.

When you're finished, click Save.

Formula editor

As you begin typing, the formula editor will suggest functions, modifiers, and variables. An explanation for each function will also appear, describing what it does and how to use it. To scroll through the list of suggestions and learn more about another item, use the up and down arrow keys.

Formula editor with suggested functions

You can also hover over the code already in your formula to see how it works.

2. Check your formula

When you click Save, Structure will review your formula, attempt to link your variables to issue fields or other attributes and notify you of any errors. If the formula is ready to be used, a green mark is displayed. If it's not, the problematic parts are highlighted in the formula editor with red color.

Formula editor with a check mark indicating a successful formula

If there are no issues, you're done! The results will appear next to the editor.



The example above is a simple formula to calculate whether or not we're on target to complete each epic on time:

CODE
IF type = "epic" :
    originalEstimate - SUM#children { timeSpent + remainingEstimate }

In case you're not yet fluent in Expr, we're telling Structure to:

  1. Check whether the Issue Type is an epic: IF type = "epic" :
  2. If so, add the Time Spent and Remaining Estimate for each child issue: { timeSpent + remainingEstimate }
  3. Total that value for all the child issues: SUM#children
  4. Subtract that total from the epic's Original Estimate: originalEstimate - ...

Handling Errors

Formula errors are typically due to one of the following:

  • Unmapped Variables - Structure attempts to map your variables to known attributes; however, depending on how you've named a variable, you may need to map it manually.
  • Syntax Error - occurs when Structure does not understand something in your formula. Often this is something as simple as missing a closing parenthesis or other punctuation. Review the formula and consult our Expr Language guide if you're unsure how to correct it. The part of the formula that failed to parse will be highlighted in red.
  • Function Resolution Error - occurs when the formula contains an unknown function. Review the formula and make sure the functions marked in red are spelled correctly. If so, check our Expr Function Reference and Aggregate Function Reference to ensure you're using a supported function. 
  • Expr Validation Error - occurs when there is a construct that is not allowed in a formula. Hover over the red highlighted part of the formula to see the error message. If multiple areas are highlighted, there are multiple errors to fix. Check the list of possible validation errors to learn more.

Handling Unexpected Results

In some cases, the formula may pass inspection, but the results aren't what you expected. You may simply need to edit your variables, options or format; or you may need to revise the formula itself by clicking the Edit button.

Full Screen

The initial sizing for the formula editor is rather small. If you need more space, click Full-Screen to expand the window.

Full-screen option in the formula window

Additional Resources

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.