Field identifiers for advanced equations

Aha! Roadmaps
Support articles
Customizations
Field identifiers for advanced equations

Advanced equations allow you to quickly access and analyze highly customizable metrics that impact your team. These metrics may include any combination of data elements in Aha! Roadmaps — including key decision-making factors like initiative costs, revenue projections, or scheduling estimates.

Add advanced equations to custom worksheets using the equation builder. These equations can calculate static fields and/or any data object that is linked to your record. Any custom worksheet you create will update automatically as you and your team make updates throughout your Aha! Roadmaps account. Custom worksheets are available to Enterprise+ Aha! Roadmaps users.

This article lists the fields that are available to you to reference in an advanced equation for each record type. Use it in conjunction with the syntax rules for building advanced equations.

Also, note that some field identifiers allow you to use logical operators to filter the data your equation will analyze.

Click any of the following links to skip ahead:

Workspaces
Goals
Initiatives
Releases / Schedules
Epics
Features / Activities
Requirements
Ideas
Proxy votes (Aha! Ideas Advanced)
Tags
Users
Custom tables (Enterprise+)
Advanced capacity estimates (Enterprise+)
Currently unsupported custom fields

Workspaces

Field identifier	Description	Example
name	Returns the workspace name as a string.*	self.name → Fredwin Cycling
description	Returns the workspace description as a string.	self.description → Fredwin Cycling enables competitive and recreational cyclists to train harder, connect with friends, and enjoy every moment on their bike.
parent	Returns information about the workspace's immediate workspace line based on fields you append to self.parent. The field type depends on the appended field.	self.parent.name → Fredwin Software
children[]	Returns a comma-separated list of the workspace's children, based on fields you append to self.children[]. The field type depends on the appended field.	self.children[].name → Fredwin Cycling, Fredwin Running, Fredwin Swimming
goals[]	Returns a comma separated list of the workspace's goals.	self.goals[].name → #1 in social fitness cycling software, Triple revenue YoY, Top rated social fitness cycling apps, Largest partner ecosystem count(self.goals[]) → 4
initiatives[]	Returns a comma separated list of the workspace's initiatives.	self.initiatives[].name → Enhance Tour de California coverage, Launch Giro d'Italia site, Mobile Fredwin Cycling Tracker App upgrades, Partner self-serve sponsorship portal and API, Support Galileo GPS system count(self.initiatives[]) → 5
ideas[]	Returns a comma separated list of all ideas associated with the workspace.	self.ideas[].reference_num → FRED-I-3, FRED-I-25
releases[]	Returns a comma separated list of the workspace's releases or schedules.	self.releases[].name → iOS v42.3 Release, Giro d'Italia Web Release, Android v3.24 Release count(self.releases[]) → 3
watchers[]	Returns a comma separated list of the workspace's watchers.	self.watchers[].name → Anne Smith, John Roberts, Karen Baker count(self.watchers[]) → 3
color	Returns the hex value for the workspace's color as a number.	self.color → 4243367
reference_prefix	Returns the workspace's reference prefix as a string.*	self.prefix → FRED
id	Returns the workspace's ID as a number.	self.id → Unique ID for your workspace

*These fields can be used to filter results using logical operators.

Top

Goals

Field identifier	Description	Example
name	Returns the goal name as a string.*	self.name → #1 in social fitness cycling software
description	Returns the goal description as a string.	self.description → We want Fredwin Technologies to be known as the top rated social fitness software company in the world. In order for that to happen, we need each of our applications to be top rated. As our flagship product, Fredwin Cycling should lead the way. We need 50% marketshare increase in order to be the true #1.
status	Returns the goal status as a string.*	self.status → On track
parents	Returns information about the goal's immediate parent(s) — workspace line goal(s) that the goal rolls up to — based on fields you append to self.parents[]. The field type depends on the appended field.	self.parents[].name → #1 in social fitness software
children	Returns information about the goals children — goal(s) that roll up to it — based on the fields you append to self.children[]. The field type depends on the appended field.	self.children[].name → #1 in active running software, #1 in active cycling software, #1 in active swimming software
project	Returns information about the goal's workspace based on fields you append to self.project. The field type depends on the appended field.	self.project.name → Fredwin Cycling self.project.color → 4243367
epoch	Returns the goal's Time frame value as a string.*	self.epoch → Q1 2019
color	Returns the hex value for the goal's color as a number.	self.color → 4243367
watchers[]	Returns a comma separated list of the goal's watchers.	self.watchers[].name → Anne Smith, John Roberts, Karen Baker count(self.watchers[]) → 3
success metric	Returns the goal's success metric as a string.	self.success_metric → +50% market share
features[]	Returns any features / activities associated with the goal (by their reference number) as a string.	self.features[].reference_num → FRED-123, FRED-44 count(self.features[]) → 18
initiatives[]	Returns any initiatives associated with the goal (by their reference number) as a string.	self.initiatives[].reference_num → FRED-S-1, FRED-S-1 count(self.initiatives[]) → 2
releases[]	Returns any releases / schedules associated with the goal (by their reference number) as a string.	self.releases[].reference_num → FRED-R-5, FRED-R-14 count(self.releases[]) → 1
reference_num	Returns the goal's reference number as a string.	self.reference_num → FRED-G-11
id	Returns the goal's ID as a number.	self.id =→ Unique ID for your goal
progress	Returns the value of the field Progress.	self.progress → Progress of your goal

*These fields can be used to filter results using logical operators.

Top

Initiatives

Field identifier	Description	Example
name	Returns the initiative name as a string.*	self.name → Enhance event coverage
description	Returns the initiative description as a string.	self.description →Drive a strong social presence around the event, and capture 60% of racers and 75% of the fans in attendance. Become the go-to mobile app for this year's race.
assigned_to_user.name	Returns the name of the user the initiative is assigned to as a string.	self.assigned_to_user.name → Bryan McCarty
status	Returns the initiative status as a string.*	self.status → On track
parent	Returns information about the initiative's immediate parent (roll up to a workspace line initiative) based on fields you append to self.parent. The field type depends on the appended field.	self.parent.name → Partner integrations
children[]	Returns a comma-separated list of the initiative's children, based on fields you append to self.children[]. The field type depends on the appended field.	self.children[].name → Expand participation, Expand social features, Improve trip planner
project	Returns information about the initiative's workspace based on fields you append to self.project. The field type depends on the appended field.	self.project.name → Fredwin Cycling self.project.color → 4243367
epoch	Returns the initiative's Time frame value as a string.*	self.epoch → Q4 2019
color	Returns the hex value for the initiative's color as a number.	self.color → 4243367
start_date	Returns the initiative's Start date value as a date.	self.start_date → 10-08-2019
end_date	Returns the initiative's End date value as a date.	self.end_date → 12-31-2019
presented	Returns the Show on charts value as a true / false boolean.	self.presented → TRUE
watchers[]	Returns a comma separated list of the initiative's watchers.	self.watchers[].name → Anne Smith, John Roberts, Karen Baker count(self.watchers[]) → 3
score	Returns the initiative score as a number.*	self.score → 14
goals[]	Returns any goals associated with the initiatives (by their reference number) as a string.	self.goals[].reference_num → FRED-G-5 count(self.goals[]) → 1
releases[]	Returns any releases or schedules associated with the initiative (by their reference number) as a string.	self.releases[].reference_num → FRED-R-5, FRED-R-14 count(self.releases[]) → 2
epics[]	Returns any epics associated with the initiative (by their reference number) as a string.	self.epics[].reference_num → FRED-E-5 count(self.epics[]) → 1
features[]	Returns any features / activities associated with the initiative (by their reference number) as a string.	self.features[].reference_num → FRED-123, FRED-138 count(self.features[]) → 18
reference_num	Returns the initiative's reference number as a string.	self.reference_num → FRED-S-5
id	Returns the initiative's ID as a number.	self.id → Unique ID for your initiative
progress	Returns the value of the field Progress.	self.progress → Progress of your initiative

*These fields can be used to filter results using logical operators.

Top

Releases / Schedules

Field identifier	Description	Example
name	Returns the release / schedule name as a string.*	self.name → iOS v4.23 Release
description	Returns the release / schedule description as a string.	self.description → Enhanced notifications and a collection of customer-requested enhancements.
status	Returns the release / schedule status as a string.*	self.status → On track
parent	Returns information about the release's / schedule's immediate parent (roll-up release or roll-up schedule) based on fields you append to self.parent. The field type depends on the appended field.	self.parent.name → iOS releases
project	Returns information about the release's / schedule's workspace based on fields you append to self.project. The field type depends on the appended field.	self.project.name → Fredwin Cycling self.project.color → 4243367
start_date	Returns the release's / schedule's Start date value as a date.	self.start_date → 10-08-2019
release_date	Returns the release's / schedule's Release date value as a date.*	self.release_date → 12-31-2019
external_release_date	Returns the release's / schedule's External release date value as a date.*	self.external_release_date → 12-31-2019
external_date_resolution	Returns the release's / schedule's External release date value as a number. Same as release date = 60 Year = 50 Half = 40 Quarter = 30 Month = 20 Week = 10 Day = 0	self.external_date_resolution → 30
release_phases[]	Returns the release's / schedule's phases and milestones (by their reference numbers) as a string.	self.release_phases[].name → Development
owner	Returns the release's / schedule's owner as a string.	self.owner → Anne Smith
watchers[]	Returns a comma separated list of the release's / schedule's watchers.	self.watchers[].name → Anne Smith, John Roberts, Karen Baker count(self.watchers[]) =→ 3
total_capacity	Returns the release's / schedule's total capacity (in minutes) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.total_capacity → 31,680
capacity_units	Returns the release's / schedule's capacity units as a number. Time = 10 Story points = 20	self.total_capacity → 20
goals[]	Returns any goals associated with the release / schedule (by their reference number) as a string.	self.goals[].reference_num → FRED-G-4 count(self.goals[]) → 1
initiatives[]	Returns any initiatives associated with the release / schedule (by their reference number) as a string.	self.initiatives[].reference_num → FRED-R-14, FRED-R-5 count(self.initiatives[]) → 2
epics[]	Returns any epics associated with the release / schedule (by their reference number) as a string.	self.epics[].reference_num → FRED-E-3 count(self.epics[]) → 1
features[]	Returns any features / activities associated with the release / schedule (by their reference number) as a string.	self.features[].reference_num → FRED-123, FRED-44 count(self.features[]) → 18
reference_num	Returns the release's / schedule's reference number as a string.*	self.reference_num → FRED-R-14
id	Returns the release's / schedule's ID as a number.	self.id → Unique ID for your release / schedule
release_phase[].name	Returns the release phase / schedule phase name as a string.	self.release_phases[].name → Development
release_phase[].description	Returns the release phase / schedule phase description as a string.	self.release_phases[].description → Engineering team work.
release_phase[].start_on	Returns the release phase / schedule phase start date as a date.* Input a phase's name in this field's brackets to return information on that phase.	self.release_phases[self.name == "Development"].start_on → 10-01-2019
release_phase[].end_on	Returns the release phase / schedule phase end date as a date.* Input a phase's name in this field's brackets to return information on that phase.	self.release_phases[self.name == "Development"].end_on → 12-31-2019
release_phase[].milestone	Uses a true / false boolean to return whether the release phase is a milestone.	self.release_phases[].milestone → FALSE
release_phases.id	Returns the release's / schedule's ID as a number.	self.release_phases[].id → Unique ID for your release / schedule phase
progress	Returns the value of the field Progress.	self.progress → Progress of your release / schedule → Progress of your release / schedule phase

*These fields can be used to filter results using logical operators.

Top

Epics

Field identifier	Description	Example
name	Returns the epic name as a string.*	self.name → Media outlet coverage
description	Returns the epic description as a string.	self.description → Enhanced media outlet coverage to improve race awareness
status	Returns the epic status as a string.*	self.status → On track
release	Returns the epic's release.	self.release.name → FRED - Global heat map
watchers[]	Returns a comma separated list of the epic's watchers.	self.watchers[].name → Anne Smith, John Roberts, Karen Baker count(self.watchers[]) → 3
score	Returns the epic score as a number.*	self.score → 14
assigned_to_user.name	Returns the name of the user the epic is assigned to as a string.	self.assigned_to_user.name → Bryan McCarty
start_date	Returns the epic's Start date value as a date.*	self.start_date → 10-01-2019
due_date	Returns the epic's Due date value as a date.*	self.due_date → 12-31-2019
detailed_estimate	Returns the epic's detailed estimate (in minutes) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.detailed_estimate → 960
remaining_estimate	Returns the epic remaining estimate (detailed_estimate minus work_done, in minutes) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.remaining_estimate → 240
work_done	Returns the remaining epic work logged (total minutes logged using Log time) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.work_done → 720
goals[]	Returns a comma separated list of the epic's goals.	self.goals[].reference_num → FRED-G-4
initiative	Returns the epic's initiative.	self.initiative.reference_num → FRED-S-4
features[]	Returns a comma separated list of all features or activities associated with the epic.	self.features[].reference_num → FRED-123, FRED-44 count(self.features[]) → 18
ideas[]	Returns a comma separated list of all ideas associated with the epic.	self.ideas[].reference_num → FRED-I-3, FRED-I-25
tags[]	Returns a comma separated list of all features associated with the epic.	self.tags[].name → French, German, 2019
reference_num	Returns the epic's reference number as a string.*	self.reference_num → FRED-E-26
id	Returns the epic's ID as a number.	self.id → Unique ID for your epic
progress	Returns the value of the field Progress.	self.progress → Progress of your epic

*These fields can be used to filter results using logical operators.

Top

Features / Activities

Field identifier	Description	Example
name	Returns the feature / activity name as a string.*	self.name → Enhanced language options
description	Returns the feature / activity description as a string.	self.description → With our international expansion, we are also increasing language options in the app. Users should be able to select from English, German, Spanish, or French in settings.
status	Returns the feature / activity status as a string.*	self.status → On track
release	Returns the feature's / activity's release.	self.release.name → iOS v42.3 Release, Giro d'Italia Web Release, Android v3.24 Release
type	Returns the feature's / activity's type.*	self.type → Improvement
release_phase.name	Returns the name of the release phase associated with the feature / activity as a string.	self.release_phase.name → Development
release_phase.description	Returns the description of the release phase associated with the feature / activity as a string.	self.release_phase.description → Engineering team work.
release_phase.start_on	Returns the start date of the release phase associated with the feature / activity as a string.	self.release_phase.start_on → 10-01-2019
release_phase.end_on	Returns the end date of the release phase associated with the feature / activity as a string.	self.release_phase.end_on → 12-31-2019
release_phase.id	Returns the ID of the release phase associated with the feature / activity as a string.*	self.release_phase.id → Unique ID for your goal
watchers[]	Returns a comma separated list of the feature's / activity's watchers.	self.watchers[].name → Anne Smith, John Roberts, Karen Baker count(self.watchers[]) → 3
score	Returns the feature / activity score as a number.*	self.score → 14
assigned_to_user.name	Returns the name of the user the feature / activity is assigned to as a string.	self.assigned_to_user.name → Erik Johnson
start_date	Returns the feature's / activity's Start date value as a date.*	self.start_date → 10-01-2019
due_date	Returns the feature's / activity's Due date value as a date.*	self.due_date → 12-31-2019
detailed_estimate	Returns the feature's / activity's detailed estimate (in minutes) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.detailed_estimate → 960
remaining_estimate	Returns the feature / activity remaining estimate (detailed_estimate minus work_done, in minutes) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.remaining_estimate → 240
work_done	Returns the remaining feature / activity work logged (total minutes logged using Log time) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.work_done → 720
goals[]	Returns a comma separated list of the feature's / activity's goals.	self.goals[].reference_num → FRED-G-6
initiative	Returns the feature's / activity's initiative.	self.initiative.reference_num → FRED-S-1
ideas[]	Returns a comma separated list of all ideas associated with the feature / activity.	self.ideas[].reference_num → FRED-I-3, FRED-I-5
tags[]	Returns a comma separated list of all features associated with the feature / activity.	self.tags[].name → German, French, Spanish, 2019
reference_num	Returns the feature's / activity's reference number as a string.*	self.reference_num → FRED-441
id	Returns the feature's / activity's ID as a number.	self.id → Unique ID for your feature / activity
progress	Returns the value of the field Progress.	self.progress → Progress of your feature / activity
requirements	Returns a feature or activity's requirement descriptions as a string.	self.requirements[].description → <p> requirement description 1 </p>, <p> requirement description 2 </p>

*These fields can be used to filter results using logical operators.

Top

Requirements

Field identifier	Description	Example
name	Returns the requirement's name as a string.*	self.name → Enhanced language options
description	Returns the requirement's description as a string.	self.description → With our international expansion, we are also increasing language options in the app. Users should be able to select from English, German, Spanish, or French in settings.
status	Returns the requirement's status as a string.*	self.status → On track
assigned_to_user.name	Returns the name of the user the requirement is assigned to as a string.	self.assigned_to_user.name → Erik Johnson
detailed_estimate	Returns the requirement's detailed estimate (in minutes) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.detailed_estimate → 960
remaining_estimate	Returns the requirement remaining estimate (detailed_estimate minus work_done, in minutes) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.remaining_estimate → 240
work_done	Returns the remaining requirement's work logged (total minutes logged using Log time) as a number. 8 hours = 1 day 5 days = 1 week 22 days = 1 month	self.work_done → 720
feature	Returns the feature the requirement is attached to.	self.feature.name → Navigation for safest routes self.feature.reference_num → FRED-442
reference_num	Returns the requirement's reference number as a string.*	self.reference_num → FRED-442-1
id	Returns the requirement's ID as a number.	self.id → Unique ID for your requirement

*These fields can be used to filter results using logical operators.

Top

Ideas

Field identifier	Description	Example
name	Returns the idea name as a string.*	self.name → France launch
description	Returns the idea description as a string.	self.description → As part of internationalization, we should expand into France.
status	Returns the idea status as a string.	self.status → On track
assigned_to_user	Returns the name of the user the idea is assigned to as a string.	self.assigned_to_user.name → Scott Schmidley
score	Returns the score for the idea as a number.*	self.score → 15
votes	Returns the total votes for the idea as a number.	self.votes → 216
idea_categories[]	Returns a comma-separated list of the categories for the idea.	self.idea_categories[].name → Map, Profile, Social
visibility	Returns the visibility of the idea as a number. Not visible in portals = 10 Visible to employees and partners = 20 Visible to all ideas portals users = 30	self.visibility → 20
project	Returns information about the idea's workspace based on fields you append to self.project. The field type depends on the appended field.	self.project.name → Fredwin Cycling self.project.color → 4243367
tags[]	Returns a comma separated list of all tags associated with the idea.	self.tags[].name → French, International, 2019
watchers[]	Returns a comma separated list of the idea's watchers.	self.watchers[].name → Anne Smith, John Roberts, Karen Baker count(self.watchers[]) → 3
reference_num	Returns the idea's reference number as a string.*	self.reference_num → FRED-I-12
id	Returns the idea's ID as a number.	self.id → Unique ID for your idea

*These fields can be used to filter results using logical operators.

Top

Proxy votes (Aha! Ideas Advanced)

Field identifier	Description	Example
self.proxy_votes[].custom.<custom_field_key>	Returns the custom field as a string or number.	self.proxy_votes[].custom.<custom_field_key> -> High priority
self.proxy_votes[].idea_organization.name	Returns the organization name as a string.	self.proxy_votes[].idea_organization.name -> Aerocycle
self.proxy_votes[].idea_organization.revenue	Returns the organization's revenue as a number.	self.proxy_votes[].idea_organization.revenue -> 600,000
self.proxy_votes[].idea_organization.custom.<custom_field_key>	Returns the custom field as a string or number.	self.proxy_votes[].idea_organization.custom.<custom_field_key> -> 200

*These fields can be used to filter results using logical operators.

Top

Users

Field identifier	Description	Example
name	Returns the user's name as a string.*	self.name → Brian de Haaff
email	Returns the user's email as a string.	self.email → support@aha.io
first_name	Returns the user's first name as a string.	self.first_name → Brian
last_name	Returns the user's last name as a string.	self.last_name → de Haaff
id	Returns the user's ID as a number.	self.id → Unique ID for your user

*These fields can be used to filter results using logical operators.

Top

Custom tables (Enterprise+)

Note: Custom tables are available to Enterprise+ users.

Field identifier

Description

Example

Any field identifier

Returns all values for a custom table's field, though you can also filter the array with logical operators.

Note: Input the custom table field's API key for the second API_key value noted in the example.

custom_table.custom_table_API_key[].custom.API_key → $1M, $3.6M, $5.03M

Top

Advanced capacity estimates (Enterprise+)

Note: Capacity planning for teams is available to Enterprise+ users.

Field identifier	Description	Example
estimate_total_headcount	Returns the total advanced estimate, in number of headcount.	self.estimate_total_headcount → 35
estimate_total_hours	Returns the total advanced estimate, in hours.	self.estimate_total_hours → 304
estimate_total_cost	Returns the total advanced estimate, in financial cost.	self.estimate_total_cost → $35,000

Top

Currently unsupported custom fields

While they are supported in advanced equations, you cannot filter an array using a custom field that returns multiple values, such as predefined tag or tags fields.

General custom fields

URL/Email field

Aha! Roadmaps relationship fields

Workspaces field
Goals field
Initiatives field
Competitors field
Creative briefs field
Personas field
Releases field
Epics field
Features field
Ideas field
Organizations field (Aha! Ideas Advanced plan)
Users field

Custom tables

Many to one

Top

Field identifiers for advanced equations

Workspaces

Goals

Initiatives

Releases / Schedules

Epics

Features / Activities

Requirements

Ideas

Proxy votes (Aha! Ideas Advanced)

Tags

Users

Custom tables (Enterprise+)

Advanced capacity estimates (Enterprise+)

Currently unsupported custom fields

General custom fields

Aha! Roadmaps relationship fields

Custom tables