Article Content
| Overview |
| User Account Requirements |
| Related Information/Setup |
| Navigation |
| Adding N-Depth Formulas to an Object Type |
Overview
N-Depth Formula variables are a special type of variable that allows data to be pulled through multiple levels of relationships, unlike standard formulas, which are limited to a single level.
Use an N-Depth formula when data needs to pass through multiple levels of relationships to aggregate data (e.g. SUM) for reporting.
It is recommended that you have already plotted out your relationship path before you attempt to add the n-depth formula.
|
Note: N-Depth Formulas can only be created in the UI using relationships. |
User Account Requirements
The user must have Administrator permissions in order to access the Admin Overview screen.
Related Information/Setup
Please refer to the following articles for further information:
Navigation
- From the Home screen, click the Administration icon.
Administration Icon
- From the Administrator settings menu, click the Admin Overview link.
Admin Overview Link
- From the Admin Overview screen, click the Object Types tile under the Data Model section
Object Types Tile
- From the Admin: Object Types screen, enter an object type name in the Search field to search for the object type you want to add an n-depth formula to.
Search Field
- Click an Object Type.
Object Type
- From the Admin: Edit Object Type screen, click the Formulas tab.
Formulas Tab
- From the Formulas tab, click on the formula you want to add an n-depth formula to or click the + Add Formula button to add a new formula for the n-depth formula.
Formula
Adding N-Depth Formulas to an Object Type
Users should apply an n-depth formula when data needs to pass through multiple levels of relationships or references for aggregate reporting.
- From the Edit Formula pop-up, scroll to the Variables section.
Variables Section
- Click the + Add Variables button.
+ Add Variables Button
- From the Variables section, select Relationship from the Variable Type dropdown menu.
Variable Type Dropdown Menu
- Select the Object Type you want to create a relationship to (data source) from the Relationship dropdown menu.
Relationship Dropdown Menu
- Click the + Add Relationship Path link to build the relationship path by indicating the different relationship levels the formula must travel through to reach the source data.
+ Add Relationship Path link
- Select the Object Type Relationship you want the path to flow through (e.g., Business Unit to Vulnerability Category) from the Path Level dropdown menu.
Path level Dropdown Menu
- Click the + Relationship link to continue adding another relationship level to the path until you have reached the destination data.
+ Relationship Link
- Click the Delete button to remove a relationship level from the path.
Delete Button
- Keep adding relationship levels until the path is complete and you have reached the destination data.
- Click the Save Path button.
Save Path Button
- (Optional) Click the Edit icon to edit the Relationship Path.
Edit Icon
- (Optional) Click the Delete icon to delete the Relationship Path.
Delete Icon
- Select components (field, formula, state, or property) from the path destination (e.g., Vulnerability) from the Available Components dropdown menu.
Available Components Dropdown Menu
- Select a sub type from the Sub Type dropdown menu. Sub types specify how the data from multiple objects are compiled, calculated, and displayed. For more information on sub types, see the sub type table in the Variables, Operations, & Functions article.
Sub Type Dropdown Menu
- Enter a variable name in the Name field. It is recommended to include NDEPTH to the name so that you can see that the variable is using an n-depth formula.
Name Field
- (Optional) Enter a brief variable description in the Description field.
Description Field
- (Optional) Select the Treat empty values as Null checkbox to exclude blank objects from a formula calculation. For more information, see the Null Values in Formulas article.
Treat Empty Values as Null Checkbox
- Click the Create Button.
Create Button
- Click the Insert Variable dropdown and select the n-depth formula that was just added to the system.
Insert Variable Dropdown Menu
- Click the Save Formula button to save the n-depth formula.
Save Formula Button