V3

V3 Actions

V3 Analysis

V3 AnalysisCalc

V3 Benefit

V3 Challenge

V3 Checkbox

V3 Evaluate

V3 GlobalVariable

V3 Image

V3 Investment

V3 Keyperformanceindicator

V3 Label

V3 Language

V3 RichTextEditor

V3 Select

V3 SummaryModel

V3 User

V3 ValueMapCategory

CheckboxCheckedTag

Deprecated.

CustomImageTag

The CustomImageTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${customImage:imageName} where imageName is the name of the image used in the tool. The text box will be removed and replaced with the image, and all animations present on the text box will be applied to the image as well. Note: this tag is used to get the users uploaded image from the Generate Report Modal.

Optional parameters include fit, scalex, and scaley. fit will generate an image that will fit inside the container and fill either the height or width of the container depending on the image's scale ratio. scalex will generate an image as wide as the container with a proportional height, and scaley will generate an image as tall as the container with a proportional width. If both scalex and scaley are included, only scalex will be applied.

Both the tag and parameters are case-insensitive.

See ReportTag for syntax.

Examples:

• ${customImage:logo,scalex}
• ${customImage:logo,scaley}
• ${customImage:logo,fit}

DuplicateSlidesTag

The DuplicateSlidesTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${duplicate:benefits,numslides=2}, ${duplicate:vmcs}, ${duplicate:sections}, or ${duplicate:investments} where the slides will be duplicated for each benefit, value map category, or investment. numslides determines how many slides will be duplicated for each benefit, value map category, or investment starting with the current slide.

Optional parameter numslides is the number of slides to copy. Default is 1.

Optional parameter filter can be used with benefits or Value map categories. Can filter by value passed in, either Monetary or Non_Monetary.

Optional parameter top or bottom can be used with benefits to list results by impact value. Takes a number for maximum results returned.

When benefit slides are duplicated, and text that contains [benefitid] will be replaced with the concrete benefit id, so tags can be nested. For example, a tag like this

${nr:DBB[benefitid]_Overview_Name} Page 1

${nr:DBB1234_Overview_Name} Page 1

nr

When value map slides are duplicated, text that contains [vmcid] will be replaced with the concrete value map category id.

When investment slides are duplicated, text that contains [investmentid] will be replaced with the concrete investment id.

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${duplicate:vmcs} - Duplicates one slide for each value map category.
• ${duplicate:sections} - Duplicates one slide for each section.
• ${duplicate:benefits,numslides=2} - Duplicates 2 slides for each benefit.
• ${duplicate:benefits, numslides=2, filter=monetary, top=3} - Duplicates 2 slide for the top 3 benefits that is monetary.
• ${duplicate:investments} - Duplicates one slide for each investment.
• ${duplicate:vmcs, filter=Non_monetary} - Duplicates one slide for each value map that is non monetary.

HideShowRowTag

Deprecated.

HighChartTag

The HighChartTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${chart:chart_name} where chart_name is the id of the chart used in the tool. The text box will be removed and replaced with the chart image, and all animations present on the text box will be applied to the image as well.

Optional parameters include fit, scalex, and scaley. fit will generate an image that will fit inside the container and fill either the height or width of the container depending on the chart's scale ratio. scalex will generate an image as wide as the container with a proportional height, and scaley will generate an image as tall as the container with a proportional width. If both scalex and scaley are included, only scalex will be applied

Both the tag and parameters are case-insensitive.

See ReportTag for syntax.

Examples:

• ${chart:roi_chart,scalex}
• ${chart:roi_chart,scaley}
• ${chart:roi_chart,fit}

KeepContentTag

Deprecated.

NamedRangeTag

Deprecated.

ShowSlideTag

Deprecated.

TableTag

The TableTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${table:table_name} where table_name is the id of the table used in the tool. The text box will be removed and replaced with the table, and all animations present on the text box will be applied to the table as well. The table will fit the width of the container the tag is placed in.

Optional parameters include scaleY which, when used in conjunction with

Optional parameter split will duplicate slides and create new tables if it does not fit on a single slide.

Optional parameter copyHeader, will share the table header on new tables created during a split.

Optional parameter headerFg will set the foreground color of the table header to the entered Hex value.

Optional parameter headerBg will set the background color of the table header to the entered Hex value.

Optional parameter textForeGround will set the foreground color of the table rows to the entered Hex value.

Optional parameter textBackground will set the background color of the table rows to the entered Hex value.

Optional parameter subTotalFg will set the foreground color of the table subtotal rows to the entered Hex value.

Optional parameter subTotalBg will set the background color of the table subtotal rows to the entered Hex value.

Optional parameter totalFg will set the foreground color of the table total rows to the entered Hex value.

Optional parameter totalBg will set the background color of the table total rows to the entered Hex value.

Optional parameter fontSize will set the font size of all cells to the entered value.

Optional parameter fontScale will scale all fonts by the entered value.

Optional parameter minimumRowHeight will set the minimum row height.

Optional parameter cellMarginLeft will set the cell left margin.

Optional parameter cellMarginRight will set the cell right margin.

Optional parameter cellMarginTop will set the cell top margin.

Optional parameter cellMarginBottom will set the cell bottom margin.

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${table:multi-year-benefits__table__benefits-by-year, fontSize=8.5}
• ${table:investment__table__annual-investment-by-category,scaley,split,fontScale=1}
• ${table:investment__table__annual-investment-by-category, headerFg=#E0E0E0, headerBg=#11a6c0, textForeground=#FF0000, textBackground=#00FF00}

CurrentDateTag

* The CurrentDateTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${date:current_date} where current_date returns the current date that the report is generated. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter fmt that accepts a date format pattern. defaults to "MMMM dd\, yyyy". Note commas must be escaped.

See ReportTag for syntax.

Examples:

• ${date:current_date}
• ${date:current_date, fmt=MM dd\, yy}
• ${date:current_date, fmt=yyyy-MM-dd}

ItemTableIdTag

The ItemTableIdTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${itemTable:id} where id returns the item table id. This typically can be used nested in a ${table} tag or other ${itemTable} tags.

Required parameter mnemonic the mnemonic of the item table.

See ReportTag for syntax.

Examples:

• ${itemTable:id,mnemonic=myMnemonic}

ItemTableNameTag

* The ItemTableNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${itemTable:name} where name returns the label name of the item table.

parameter id the id number of the item table.
parameter mnemonic the mnemonic of the item table.
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${itemTable:name, mnemonic=itemTable1}
• ${itemTable:name, id=7}

ItemTableVisibilityTag

* The ItemTableVisibilityTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${itemTable:visibility} where visibility returns true or false if the item table was visible in the application.

parameter id the id number of the item table.
parameter mnemonic the mnemonic of the item table.
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${itemTable:visibility, mnemonic=itemTable1}
• ${itemTable:visibility, id=7}

LeadCaptureFieldValueTag

The LeadCaptureFieldValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${lead:field_value} where field_value returns the value of the field

required parameter field_name the field_name for the requested field value.

See ReportTag for syntax.

Examples:

• ${lead:field_value, field_name=FirstName}
• ${lead:field_value, field_name=utm_campaign}

SectionIdTag

The SectionIdTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${section:id}

Tag is an alias, see ItemTableIdTag for more information.

See ReportTag for syntax.

Examples:

• ${section:id,mnemonic=myMnemonic}

SectionNameTag

The SectionNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${section:name}

Tag is an alias, see ItemTableNameTag for more information.

See ReportTag for syntax.

Examples:

• ${section:name, mnemonic=section1}
• ${section:name, id=7}

SectionVisibilityTag

The SectionVisibilityTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${section:visibility}

Tag is an alias, see ItemTableVisibilityTag for more information.

See ReportTag for syntax.

Examples:

• ${section:visibility, mnemonic=section1}
• ${section:visibility, id=7}

ShowAltTextIf

The ShowAltTextIf class is applied to PowerPoint Report Templates when the following text is found in the alternate text of a shape: ${showAltTextIf:{tag value}, eq={comparison value}} where {tag value} can be an existing tag whose value will be evaluated to the {comparison value}.
The results of which, if evaluated as true will show the content in the presentation.

parameter eq test if the {tag value} is equal to this attribute
parameter neq test if the {tag value} is not equal to this attribute
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${showAltTextIf:${tickbox:checked, mnemonic=tickbox1}, eq=true}
• ${showAltTextIf:${calc:industry}, neq=Aerospace & Defense}

ShowColumnIf

The ShowColumnIf class is applied to PowerPoint Report Templates when the following text is found in a table cell: ${showColumnIf:{tag value}, eq={comparison value}} where {tag value} can be an existing tag whose value will be evaluated to the {comparison value}.
The results of which, if evaluated as true will show the column in the table.

parameter eq test if the {tag value} is equal to this attribute
parameter neq test if the {tag value} is not equal to this attribute
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${showColumnIf:${tickbox:checked, mnemonic=tickbox1}, eq=true}
• ${showColumnIf:${calc:industry}, neq=Aerospace & Defense}

ShowRowIf

The ShowRowIf class is applied to PowerPoint Report Templates when the following text is found in a table cell: ${showRowIf:{tag value}, eq={comparison value}} where {tag value} can be an existing tag whose value will be evaluated to the {comparison value}.
The results of which, if evaluated as true will show the row in the table.

parameter eq test if the {tag value} is equal to this attribute
parameter neq test if the {tag value} is not equal to this attribute
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${showRowIf:${tickbox:checked, mnemonic=tickbox1}, eq=true}
• ${showRowIf:${calc:industry}, neq=Aerospace & Defense}

ShowSlideIfTag

The ShowSlideIfTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${showSlideIf:{tag value}, eq={comparison value}} where {tag value} can be an existing tag whose value will be evaluated to the {comparison value}.
The results of which, if evaluated as true will show the current slide.

parameter eq test if the {tag value} is equal to this attribute
parameter neq test if the {tag value} is not equal to this attribute
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${showSlideIf:${tickbox:checked, mnemonic=tickbox1}, eq=true}
• ${showSlideIf:${calc:industry}, neq=Aerospace & Defense}

CurrencyIsoCodeTag

The CurrencyIsoCodeTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${currency:iso} where it will return the currency iso code that was selected. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${currency:iso}

CurrencyNameTag

The CurrencyNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${currency:name} where it will return the currency name that was selected. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${currency:name}

TemplateNameTag

* The TemplateNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${template:name} where it will return the template name that was used to create the analysis. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${template:name}

AnalysisPeriodTag

* The AnalysisPeriodTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:analysis_period} where analysis_period returns current analysis period in years. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:analysis_period}

AnnualGrowthRateTag

The AnnualGrowthRateTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:annual_growth_rate} where annual_growth_rate returns the current annual growth rate percentage. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:annual_growth_rate}

AvgAnnualBenefitsTag

* The AvgAnnualBenefitsTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:avg_ann_benefits} where avg_ann_benefits returns the average cumulative benefits over the analysis period based on the projection. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:avg_ann_benefits}
• ${calc:avg_ann_benefits, projection=Probable, scale=0.001, unit=k, dec=2}
• ${calc:avg_ann_benefits, raw}

BenefitCurrentSumTotalOverPeriodTag

The BenefitCurrentSumTotalOverPeriodTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:benefit_current_sum_over_period} where benefit_current_sum_over_period returns the total sum of all monetary benefits current values including recurrence over analysis period. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:benefit_current_sum_over_period}
• ${calc:benefit_current_sum_over_period, projection=Probable, scale=0.001, unit=k, dec=2}
• ${calc:benefit_current_sum_over_period, raw}

BenefitCurrentSumTotalTag

The BenefitCurrentSumTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:benefit_current_sum} where benefit_current_sum returns the total sum of all monetary benefits current values. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:benefit_current_sum}
• ${calc:benefit_current_sum, projection=Probable, scale=0.001, unit=k, dec=2}
• ${calc:benefit_current_sum, raw}

BenefitProposedSumTotalOverPeriodTag

The BenefitProposedSumTotalOverPeriodTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:benefit_proposed_sum_over_period} where benefit_proposed_sum_over_period returns the total sum of all monetary benefits proposed values including recurrence over analysis period. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:benefit_proposed_sum_over_period}
• ${calc:benefit_proposed_sum_over_period, projection=Probable, scale=0.001, unit=k, dec=2}
• ${calc:benefit_proposed_sum_over_period, raw}

BenefitProposedSumTotalTag

The BenefitProposedSumTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:benefit_proposed_sum} where benefit_proposed_sum returns the total sum of all benefits proposed values. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:benefit_proposed_sum}
• ${calc:benefit_proposed_sum, projection=Probable, scale=0.001, unit=k, dec=2}
• ${calc:benefit_proposed_sum, raw}

CashFlowTableTag

The CashFlowTableTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:table_cash_flow} where table_cash_flow will return a Cash flow table.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter headerFg will set the foreground color of the table header to the entered Hex value.

Optional parameter headerBg will set the background color of the table header to the entered Hex value.

Optional parameter textForeGround will set the foreground color of the table rows to the entered Hex value.

Optional parameter textBackground will set the background color of the table rows to the entered Hex value.

Optional parameter subTotalFg will set the foreground color of the table subtotal rows to the entered Hex value.

Optional parameter subTotalBg will set the background color of the table subtotal rows to the entered Hex value.

Optional parameter totalFg will set the foreground color of the table total rows to the entered Hex value.

Optional parameter totalBg will set the background color of the table total rows to the entered Hex value.

Optional parameter theme will set a default background color and text color for all rows (colors overwritten by above options). Accepts the following values:

• light
• dark

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${calc:table_cash_flow, projection=Conservative}
• ${calc:table_cash_flow, projection=Conservative, theme=dark}

CodnQuarterlyTag

* The CodnQuarterlyTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:codn_q} where codn_q returns current cost of do nothing quarterly. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter realized will return the realized value if present.

See ReportTag for syntax.

Examples:

• ${calc:codn_q}
• ${calc:codn_q, scale=0.001, unit=k, dec=2}
• ${calc:codn_q, raw}

CodnTag

* The CodnTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:codn} where codn returns current cost of do nothing. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter realized will return the realized value if present.

See ReportTag for syntax.

Examples:

• ${calc:codn}
• ${calc:codn, scale=0.001, unit=k, dec=2}
• ${calc:codn, raw}

CompanyNameTag

* The CompanyNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:company_name} where company_name returns the user entered company name. The text will be replaced in-line (as opposed to removing and replacing the container). Note: tag requires a text input with the mnemonic tb-companyName.

See ReportTag for syntax.

Examples:

• ${calc:company_name}

CumulativeBenefitByYearTag

* The CumulativeBenefitByYearTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:cumulative_benefit_by_year, year=1} where cumulative_benefit_by_year, year=1 returns the cumulative benefit by year. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter year selects year the value should return.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

See ReportTag for syntax.

Examples:

• ${calc:cumulative_benefit_by_year, year=0}
• ${calc:cumulative_benefit_by_year, year=1, scale=0.001, unit=k, dec=2}
• ${calc:cumulative_benefit_by_year, year=1, raw}

CumulativeBenefitTag

* The CumulativeBenefitTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:cumulative_benefits} where cumulative_benefits returns the total cumulative benefit for the analysis period based on the projection. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:cumulative_benefits}
• ${calc:cumulative_benefits, projection=Probable, scale=0.001, unit=k, dec=2}
• ${calc:cumulative_benefits, raw}

CumulativeNetBenefitByYearTag

* The CumulativeNetBenefitByYearTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:cumulative_net_benefit_by_year} where cumulative_net_benefit_by_year returns the cumulative net benefit by year. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter year selects year the value should return.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

See ReportTag for syntax.

Examples:

• ${calc:cumulative_net_benefit_by_year, year=0}
• ${calc:cumulative_net_benefit_by_year, year-1, scale=0.001, unit=k, dec=2}
• ${calc:cumulative_net_benefit_by_year, raw, year=0}

CumulativeNetBenefitTag

* The CumulativeNetBenefitTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:cumulative_net_benefit} where cumulative_net_benefit returns the current cumulative net benefits. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

See ReportTag for syntax.

Examples:

• ${calc:cumulative_net_benefit}
• ${calc:cumulative_net_benefit, scale=0.001, unit=k, dec=2}

CurrentProjectionTag

* The CurrentProjectionTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:current_projection} where current_projection returns the label of the users selected projection. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:current_projection}

DeploymentPeriodTag

The DeploymentPeriodTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:deployment_period} where deployment_period returns the current deployment period in months. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:deployment_period}

DirectBenefitRealizationTag

The DirectBenefitRealizationTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:direct_benefit_realization} where direct_benefit_realization returns the current direct benefit realization percentage. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:direct_benefit_realization}

DiscountRateTag

The DiscountRateTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:discount_rate} where discount_rate returns the current discount rate. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:discount_rate}

IndirectBenefitRealizationTag

The IndirectBenefitRealizationTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:indirect_benefit_realization} where indirect_benefit_realization returns the current indirect benefit realization percentage. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:indirect_benefit_realization}

IndustryTag

* The IndustryTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:industry} where industry returns the label of the users selected industry. The text will be replaced in-line (as opposed to removing and replacing the container). Note: tag requires a text input with the mnemonic tb-industry

See ReportTag for syntax.

Examples:

• ${calc:industry}

IrrTag

* The IrrTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:IRR} where IRR returns the current IRR. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:IRR}
• ${calc:IRR, projection=Conservative}
• ${calc:IRR, raw}

LocationTag

* The LocationTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:location} where location returns the label of the users selected location. The text will be replaced in-line (as opposed to removing and replacing the container). Note: tag depends on a text input with the mnemonic tb-location

See ReportTag for syntax.

Examples:

• ${calc:location}

NetBenefitByYearTag

The NetBenefitByYearTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:net_benefit_by_year, year=1} where net_benefit_by_year, year=1 returns the net benefit by year. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter year selects year the value should return.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

See ReportTag for syntax.

Examples:

• ${calc:net_benefit_by_year, year=0}
• ${calc:net_benefit_by_year, year=1, scale=0.001, unit=k, dec=2}
• ${calc:net_benefit_by_year, raw, year=0}

NpvTag

* The NpvTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:NPV} where NPV returns the current NPV. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

See ReportTag for syntax.

Examples:

• ${calc:NPV}
• ${calc:NPV, scale=0.001, unit=k, dec=2}
• ${calc:NPV, raw}

PaybackTag

* The PaybackTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:payback} where payback returns the label for the current payback period. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

See ReportTag for syntax.

Examples:

• ${calc:payback}

PotentialBenefitTag

* The PotentialBenefitTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:potential_benefit} where potential_benefit returns the total of the unrealized potential impact of the benefits. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:potential_benefit}
• ${calc:potential_benefit, scale=0.001, unit=k, dec=2}
• ${calc:potential_benefit, raw}

RoiPerYearTag

* The RoiPerYearTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:ROI_per_year} where ROI_per_year returns the ROI per year. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter year returns year the value should return. Default is year 1.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

See ReportTag for syntax.

Examples:

• ${calc:ROI_per_year}
• ${calc:ROI_per_year, year=0}
• ${calc:ROI_per_year, year=5, scale=0.001, unit=k, dec=2}
• ${calc:ROI_per_year, raw, year=0}

RoiTag

* The RoiTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:ROI} where ROI returns the current ROI. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:ROI}
• ${calc:ROI, raw}

SimpleRealizationByYearTag

The SimpleRealizationByYearTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:realization_by_year} where realization_by_year returns the realization by year. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter year returns year the value should return. Default is year 1.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:realization_by_year}
• ${calc:realization_by_year, year=1}
• ${calc:realization_by_year, year=5, projecton=Conservative}
• ${calc:realization_by_year, raw, year=1}

TemplateModeTag

The TemplateModeTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:template_mode} where template_mode returns default template mode set, or user selected mode if template was set to "User Select". The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${calc:template_mode}

TotalDirectBenefitsTag

* The TotalDirectBenefitsTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:total_direct_benefits} where total_direct_benefits returns the total direct benefit. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:total_direct_benefits}
• ${calc:total_direct_benefits, scale=0.001, unit=k, dec=2}
• ${calc:total_direct_benefits, raw}

TotalIndirectBenefitsTag

* The TotalIndirectBenefitsTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:total_indirect_benefits} where total_indirect_benefits returns the total indirect benefit. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${calc:total_indirect_benefits}
• ${calc:total_indirect_benefits, scale=0.001, unit=k, dec=2}
• ${calc:total_indirect_benefits, raw}

TotalRealizedBenefitsTag

The TotalRealizedBenefitsTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${calc:total_realized_benefits} where total_realized_benefits returns the total realized benefit for the year. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter year the year the value should return. Default is year 1.

See ReportTag for syntax.

Examples:

• ${calc:total_realized_benefits, year=1}
• ${calc:total_realized_benefits, scale=0.001, unit=k, dec=2}
• ${calc:total_realized_benefits, raw, year=1}

BenefitAnnualGrowthRateTag

* The BenefitAnnualGrowthRateTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:annual_growth_rate} where annual_growth_rate returns the annual growth rate of the benefit.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:annual_growth_rate, mnemonic=benefit1}
• ${benefit:annual_growth_rate, id=7}
• ${benefit:annual_growth_rate, raw, mnemonic=benefit1}

BenefitAverageIdealTotalTag

The BenefitAverageIdealTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:average_ideal_total} where average_ideal_total returns the average ideal total over the analysis period based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:average_ideal_total, mnemonic=benefit1}
• ${benefit:average_ideal_total, id=7, scale=0.001, unit=k, dec=2}
• ${benefit:average_ideal_total, raw, mnemonic=benefit1}

BenefitAverageRealizedTotalTag

The BenefitAverageRealizedTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:average_realized_total} where average_realized_total returns the average realized total over the analysis period based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:average_realized_total, mnemonic=benefit1}
• ${benefit:average_realized_total, id=7, scale=0.001, unit=k, dec=2}
• ${benefit:average_realized_total, raw, mnemonic=benefit1}

BenefitBenefitTextTag

* The BenefitBenefitTextTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:benefit_text} where benefit_text returns the benefit text of the benefit.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML.

See ReportTag for syntax.

Examples:

• ${benefit:benefit_text, mnemonic=benefit1}
• ${benefit:benefit_text, id=7}

BenefitCalcTableTag

The BenefitCalcTableTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:table_calc} where table_calc will return a table of the benefit calculator.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter headerFg will set the foreground color of the table header to the entered Hex value.

Optional parameter headerBg will set the background color of the table header to the entered Hex value.

Optional parameter textForeGround will set the foreground color of the table rows to the entered Hex value.

Optional parameter textBackground will set the background color of the table rows to the entered Hex value.

Optional parameter subTotalFg will set the foreground color of the table subtotal rows to the entered Hex value.

Optional parameter subTotalBg will set the background color of the table subtotal rows to the entered Hex value.

Optional parameter totalFg will set the foreground color of the table total rows to the entered Hex value.

Optional parameter totalBg will set the background color of the table total rows to the entered Hex value.

Optional parameter theme will set a default background color and text color for all rows (colors overwritten by above options). Accepts the following values:

• light
• dark

Optional parameter hideFormula will not show total formula in table.

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${benefit:table_calc, id=1, projection=Conservative}
• ${benefit:table_calc, id=1 headerFg=#E0E0E0, headerBg=#11a6c0}
• ${benefit:table_calc, mnemonic=benefit1, theme=dark}

BenefitCalloutTag

The BenefitCalloutTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:callout, row=[row id], column=[property]} where callout returns the information related to a benefit callout.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Required parameter row is the row identifier for the callout.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection.

Optional parameter column is the property column for the callout (e.g. label, tooltip, value). Default is the callouts label / display name

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:callout, mnemonic=benefit1, row=A, column=label}
• ${benefit:callout, mnemonic=benefit1, row=A, column=tooltip}
• ${benefit:callout, mnemonic=benefit1, row=A, column=value, projection=probable}
• ${benefit:callout, id=7, row=A}
• ${benefit:callout, raw, mnemonic=benefit1, row=A, column=value}

BenefitChallengeTextTag

* The BenefitChallengeTextTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:challenge_text} where challenge_text returns the challenge text of the benefit.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML.

See ReportTag for syntax.

Examples:

• ${benefit:challenge_text, mnemonic=benefit1}
• ${benefit:challenge_text, id=7}

BenefitComprehensiveRealizationTag

* The BenefitComprehensiveRealizationTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:comprehensive_realization} where comprehensive_realization returns the comprehensive realization of the benefit.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:comprehensive_realization, mnemonic=benefit1}
• ${benefit:comprehensive_realization, id=7}
• ${benefit:comprehensive_realization, raw, mnemonic=benefit1}

BenefitDeploymentTimeTag

* The BenefitDeploymentTimeTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:deployment_time} where deployment_time returns the time to deploy in months of the benefit.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${benefit:deployment_time, mnemonic=benefit1}
• ${benefit:deployment_time, id=7}

BenefitDescriptionTag

* The BenefitDescriptionTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:description} where description returns the description of the benefit.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${benefit:description, mnemonic=benefit1}
• ${benefit:description, id=7}

BenefitIconTag

The BenefitIconTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:icon,id=benefitId} where benefitId is a valid benefit id. It will display the benefit icon.

Parameter id is required. Optional parameters include fit, scalex, and scaley. fit will generate an image that will fit inside the container and fill either the height or width of the container depending on the icon's scale ratio. scalex will generate an image as wide as the container with a proportional height, and scaley will generate an image as tall as the container with a proportional width. If both scalex and scaley are included, only scalex will be applied.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${benefit:icon,id=benefitId}
• ${benefit:icon,id=benefitId, fit}
• ${benefit:icon,id=benefitId, scalex}
• ${benefit:icon,id=benefitId, scaley}

BenefitIdByRankTag

The BenefitIdByRankTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:id_by_rank} where id_by_rank returns the id of a selected benefit based on the rank of its impact value. i.e. Highest or Lowest value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Required parameter top or bottom a number which the id returned is ranked by. If the rank entered is beyond scope of benefits the next rank is returned.

Optional parameter filter accepts the value passed in, either Monetary or Non_Monetary. Monetary is default.

See ReportTag for syntax.

Examples:

• ${benefit:id_by_rank, top=3}
• ${benefit:id_by_rank, projection=Optimistic, bottom=2}

BenefitImpactRealizedTag

The BenefitImpactRealizedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:impact_realized} where impact_realized returns the realized impact of the benefit based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter year returns year the value should return. Default is year 1.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:impact_realized, mnemonic=benefit1}
• ${benefit:impact_realized, id=7, scale=0.001, unit=k, dec=2}
• ${benefit:impact_realized, raw, mnemonic=benefit1}

BenefitImpactUnrealizedTag

* The BenefitImpactUnrealizedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:impact_unrealized} where impact_unrealized returns the unrealized impact of the benefit based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter year returns year the value should return. Default is year 1.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:impact_unrealized, mnemonic=benefit1}
• ${benefit:impact_unrealized, id=7, scale=0.001, unit=k, dec=2}
• ${benefit:impact_unrealized, raw, mnemonic=benefit1}

BenefitIsIncludedTag

* The BenefitIsIncludedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:included} where included returns true or false if the benefit was included in the value summary

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${benefit:included, mnemonic=benefit1}
• ${benefit:included, id=7}

BenefitLineItemTag

The BenefitLineItemTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:line_item, row=[row id], column=[column label]} where line_item returns the information related to the benefit line item.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Required parameter row is the row identifier for the line item.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection.

Optional parameter column is the column label for the line item (e.g. label, current, impact, proposed). Default is the line items label / display name

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:line_item, mnemonic=benefit1, row=A, column=label}
• ${benefit:line_item, mnemonic=benefit1, row=A, column=proposed, projection=probable}
• ${benefit:line_item, id=7}
• ${benefit:line_item, mnemonic=benefit1, raw, row=A, column=proposed}

BenefitNameTag

* The BenefitNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:name} where name returns the label name of the benefit.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${benefit:name, mnemonic=benefit1}
• ${benefit:name, id=7}

BenefitProposedRealized

Deprecated.

BenefitProposedTotalTag

The BenefitProposedTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:proposed_total} where proposed_total returns the proposed total value of the benefit based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:proposed_total, mnemonic=benefit1}
• ${benefit:proposed_total, id=7, scale=0.001, unit=k, dec=2}
• ${benefit:proposed_total, raw, mnemonic=benefit1}

BenefitQuarterlySummaryTableTag

The BenefitQuarterlySummaryTableTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:table_quarterly_summary} where table_quarterly_summary will return a table of the benefit quarterly summary, including realization and deployment offset.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter headerFg will set the foreground color of the table header to the entered Hex value.

Optional parameter headerBg will set the background color of the table header to the entered Hex value.

Optional parameter textForeGround will set the foreground color of the table rows to the entered Hex value.

Optional parameter textBackground will set the background color of the table rows to the entered Hex value.

Optional parameter subTotalFg will set the foreground color of the table subtotal rows to the entered Hex value.

Optional parameter subTotalBg will set the background color of the table subtotal rows to the entered Hex value.

Optional parameter totalFg will set the foreground color of the table total rows to the entered Hex value.

Optional parameter totalBg will set the background color of the table total rows to the entered Hex value.

Optional parameter theme will set a default background color and text color for all rows (colors overwritten by above options). Accepts the following values:

• light
• dark

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${benefit:table_quarterly_summary, id=1, projection=Conservative}
• ${benefit:table_quarterly_summary, id=1 headerFg=#E0E0E0, headerBg=#11a6c0}
• ${benefit:table_quarterly_summary, mnemonic=benefit1, theme=dark}

BenefitRealizationByYearTag

The BenefitRealizationByYearTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:realization_by_year} where realization_by_year returns the realization by year of the benefit based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter year returns year the value should return. Default is year 1.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:realization_by_year, mnemonic=benefit1}
• ${benefit:realization_by_year, id=7}
• ${benefit:realization_by_year, id=7, year=1, projection=probable}
• ${benefit:realization_by_year, raw, mnemonic=benefit1}

BenefitRealizationTableTag

The BenefitRealizationTableTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:table_realization} where table_realization will return a table of the realization summary for a benefit

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter headerFg will set the foreground color of the table header to the entered Hex value.

Optional parameter headerBg will set the background color of the table header to the entered Hex value.

Optional parameter textForeGround will set the foreground color of the table rows to the entered Hex value.

Optional parameter textBackground will set the background color of the table rows to the entered Hex value.

Optional parameter subTotalFg will set the foreground color of the table subtotal rows to the entered Hex value.

Optional parameter subTotalBg will set the background color of the table subtotal rows to the entered Hex value.

Optional parameter totalFg will set the foreground color of the table total rows to the entered Hex value.

Optional parameter totalBg will set the background color of the table total rows to the entered Hex value.

Optional parameter theme will set a default background color and text color for all rows (colors overwritten by above options). Accepts the following values:

• light
• dark

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${benefit:table_realization, id=1,}
• ${benefit:table_realization, id=1 headerFg=#E0E0E0, headerBg=#11a6c0}
• ${benefit:table_realization, mnemonic=benefit1, theme=dark}

BenefitTotalRealizedImpactTag

The BenefitTotalRealizedImpactTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:total_realized_impact} where total_realized_impact returns the total realized impact of the benefit based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:total_realized_impact, mnemonic=benefit1}
• ${benefit:total_realized_impact, id=7, scale=0.001, unit=k, dec=2}
• ${benefit:total_realized_impact, raw, mnemonic=benefit1}

BenefitValueTotal

The BenefitValueTotal class is applied to PowerPoint Report Templates when the following text is found in a text box: ${benefit:value_total} where value_total returns the current total value of the benefit based on the projection.

parameter id the id number of the benefit.
parameter mnemonic the mnemonic of the benefit.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${benefit:value_total, mnemonic=benefit1}
• ${benefit:value_total, id=7, scale=0.001, unit=k, dec=2}
• ${benefit:value_total, raw, mnemonic=benefit1}

ChallengeNameTag

* The ChallengeNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${challenge:name} where name returns the label name of the challenge. The text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the challenge.
parameter mnemonic the mnemonic of the challenge.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${challenge:name, id=3}
• ${challenge:name, mnemonic=challenge3}

ChallengeTooltipTag

The ChallengeTooltipTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${challenge:tooltip} where tooltip returns the tool tip of the challenge. The text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the challenge.
parameter mnemonic the mnemonic of the challenge.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${challenge:tooltip, id=3}
• ${challenge:tooltip, mnemonic=challenge3}

ChallengeValueTag

The ChallengeValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${challenge:value} where value returns the label value of the challenge. The text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the challenge.
parameter mnemonic the mnemonic of the challenge.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter raw will return the value in default English (e.g. top, high, none). Commonly used in conjuction with evaluate or action tags.

See ReportTag for syntax.

Examples:

• ${challenge:value, id=3}
• ${challenge:value, mnemonic=challenge3}

TickboxNameTag

The TickboxNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${tickbox:name} where name returns the label of the tickbox.

required parameter mnemonic the mnemonic of the tickbox.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${tickbox:name, mnemonic=tickbox1}

TickboxTickedTag

The TickboxTickedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${tickbox:checked} where checked will return true or false if the check box was checked in the application.
${tickbox:unchecked} where unchecked returns true or false if the check box was unchecked in the application.

required parameter mnemonic the mnemonic of the tickbox.

See ReportTag for syntax.

Examples:

• ${tickbox:checked, mnemonic=tickbox1}
• ${tickbox:unchecked, mnemonic=tickbox1}

TickboxTooltipTag

The TickboxTooltipTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${tickbox:tooltip} where tooltip returns tool tip of the tickbox.

required parameter mnemonic the mnemonic of the tickbox.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${tickbox:tooltip, mnemonic=tickbox1}

EvaluateAndTag

The EvaluateAndTag class is applied to PowerPoint Report Templates when the following text is found: ${eval:and, tags=[{Tag value}], compareTo={comparison}} where tags will be be compared to the {comparison}. Returns true if all tags are equal to the comparison value. Can be used in conjuction with ${eval:gt}, ${eval:lt}, and ${eval:eq} nested within tags.
Note if wanting to check if multiple options were used in a Select item it may be easier to use SelectValueIncludedTag instead with the include=all parameter.

required attribute tags accepts multiple valid report tags. Tags passed in must be surrounded by [ ] brackets and ; separated. Tags passed in should evaluate to true or false for best results in comparison.

required attribute compareTo accepts either text or number or a valid tag that will evaluate to text or number.

See ReportTag for syntax.

Examples:

• ${eval:and, tags=[${eval:gt, tag=${calc:analysis_period}, compareTo=3}; ${tickbox:checked, mnemonic=tickbox1}]}

EvaluateEqualsTag

The EvaluateEqualsTag class is applied to PowerPoint Report Templates when the following text is found: ${eval:eq, tag={Tag value}, compareTo={comparison}} where a tag can be compared to the {comparison}. Returns true if tag is equal to comparison value

required attribute tag accepts a valid report tag. Tag can evaluate to either text or number

required attribute compareTo accepts either text or number or a valid tag that will evaluate to text or number.

optional attribute dec accepts a number to be used to round values when comparing.

See ReportTag for syntax.

Examples:

• ${eval:eq, tag=${calc:analysis_period}, compareTo=4}
• ${eval:eq, tag=${global:current_value, raw}, compareTo=300, dec=0}

EvaluateGreaterThanTag

The EvaluateGreaterThanTag class is applied to PowerPoint Report Templates when the following text is found: ${eval:gt, tag={Tag value}, compareTo={comparison}} where a {Tag value} can be compared to the {comparison}. Returns true if tag is greater than comparison value

required attribute tag accepts a valid report tag that evaluates to a number. Raw attribute recommended for nested tag to compare numbers without formatting

required attribute compareTo accepts a number or a valid tag that will evaluate to a number to be used to compare to tag. Raw attribute recommended for nested tag to compare numbers without formatting.

optional attribute dec accepts a number to be used to round values when comparing.

See ReportTag for syntax.

Examples:

• ${eval:gt, tag=${calc:analysis_period}, compareTo=4}
• ${eval:gt, tag=${global:current_value, raw}, compareTo=300, dec=0}

EvaluateLessThanTag

The EvaluateLessThanTag class is applied to PowerPoint Report Templates when the following text is found: ${eval:lt, tag={Tag value}, compareTo={comparison}} where a {Tag value} can be compared to the {comparison}. Returns true if tag is less than comparison value

required attribute tag accepts a valid report tag that evaluates to a number. Raw attribute recommended for nested tag to compare numbers without formatting

required attribute compareTo accepts a number or a valid tag that will evaluate to a number to be used to compare to tag. Raw attribute recommended for nested tag to compare numbers without formatting.

optional attribute dec accepts a number to be used to round values when comparing.

See ReportTag for syntax.

Examples:

• ${eval:lt, tag=${calc:analysis_period}, compareTo=4}
• ${eval:lt, tag=${global:current_value, raw}, compareTo=300, dec=0}

EvaluateNotEqualsTag

The EvaluateNotEqualsTag class is applied to PowerPoint Report Templates when the following text is found: ${eval:neq, tag={Tag value}, compareTo={comparison}} where a Tag value can be compared to the {comparison}. Returns true if tag is not equal to comparison value

required attribute tag accepts a valid report tag that evaluates to a number. Raw attribute recommended for nested tag to compare numbers without formatting

required attribute compareTo accepts a number or a valid tag that will evaluate to a number to be used to compare to tag. Raw attribute recommended for nested tag to compare numbers without formatting.

optional attribute dec accepts a number to be used to round values when comparing.

See ReportTag for syntax.

Examples:

• ${eval:neq, tag=${calc:analysis_period}, compareTo=4}
• ${eval:neq, tag=${global:current_value, raw}, compareTo=300, dec=0}

EvaluateOrTag

The EvaluateOrTag class is applied to PowerPoint Report Templates when the following text is found: ${eval:or, tags=[{Tag value}], compareTo={comparison}} where tags will be be compared to the {comparison}. Returns true if any tag is equal to comparison value. Can be used in conjuction with ${eval:gt}, ${eval:lt}, and ${eval:eq} nested within tags.
Note if wanting to check if multiple options were used in a Select item it may be easier to use SelectValueIncludedTag instead.

required attribute tags accepts multiple valid report tags. Tags passed in must be surrounded by [ ] brackets and ; separated. Tags passed in should evaluate to true or false for best results in comparison.

required attribute compareTo accepts either text or number or a valid tag that will evaluate to text or number.

See ReportTag for syntax.

Examples:

• ${eval:and, tags=[${eval:gt, tag=${calc:analysis_period}, compareTo=3}; ${tickbox:checked, mnemonic=tickbox1}]}

GlobalVariableCurrentValueTag

The GlobalVariableCurrentValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${global:current_value} where current_value returns the current value of the global variable.

parameter id the id number of the global variable.
parameter mnemonic the mnemonic of the global variable.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${global:current_value, mnemonic=gv1}
• ${global:current_value, id=7}
• ${global:current_value, mnemonic=gv1, scale=0.001, unit=k, dec=2}
• ${global:current_value, mnemonic=gv1, raw}

GlobalVariableImpactValuetag

The GlobalVariableImpactValuetag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${global:impact_value} where impact_value returns the default set impact value of the global variable. For impact values associated via a benefit line item see BenefitLineItemTag

parameter id the id number of the global variable.
parameter mnemonic the mnemonic of the global variable.
Only one parameter is required for the tag, while the other can be omitted.

optional parameter projection the projection value to return. Defaults to analysis current selected projection.

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${global:impact_value, mnemonic=gv1, projection=Conservative}
• ${global:impact_value, id=7}
• ${global:impact_value, mnemonic=gv1, raw}

GlobalVariableLabelTag

The GlobalVariableLabelTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${global:label} where label returns the label name of the global variable.

parameter id the id number of the global variable.
parameter mnemonic the mnemonic of the global variable.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${global:label, mnemonic=gv1}
• ${global:label, id=7}

GlobalVariableProposedValueTag

The GlobalVariableProposedValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${global:proposed_value} where proposed_value returns the default set proposed value of the global variable. For impact values associated via a benefit line item see BenefitLineItemTag

parameter id the id number of the global variable.
parameter mnemonic the mnemonic of the global variable.
Only one parameter is required for the tag, while the other can be omitted.

optional parameter projection the projection value to return. Defaults to analysis current selected projection.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${global:proposed_value, mnemonic=gv1, projection=Conservative}
• ${global:proposed_value, id=7}
• ${global:proposed_value, id=7, scale=0.001, unit=k, dec=2}
• ${global:proposed_value, mnemonic=gv1, raw}

GlobalVariableTooltipTag

The GlobalVariableTooltipTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${global:tooltip} where tooltip returns the tool tip of the global variable.

parameter id the id number of the global variable.
parameter mnemonic the mnemonic of the global variable.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${global:tooltip, mnemonic=gv1}
• ${global:tooltip, id=7}

ImageTag

The ImageTag is currently not supported.

InvestmentAnnualTotalTag

* The InvestmentAnnualTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${investment:invested_annual_total} where invested_annual_total returns the total annual investment for the specified year. The text will be replaced in-line (as opposed to removing and replacing the container).

Parameter year returns year the value should return.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${investment:invested_annual_total, year=1}
• ${investment:invested_annual_total, year=1, scale=0.001, unit=k, dec=2}
• ${investment:invested_annual_total, year=1, raw}

InvestmentAnnualValueTag

The InvestmentAnnualValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${investment:annual_value} where annual_value returns the annual value of the investment. The text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the investment.
parameter mnemonic the mnemonic of the investment.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter year returns year the value should return. Default is the initial value (e.g. year 0).

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${investment:annual_value, id=[investmentid]}
• ${investment:annual_value, mnemonic=invest1, year=1}
• ${investment:annual_value, id=123, scale=0.001, unit=k, dec=2}
• ${investment:annual_value, mnemonic=invest1, year=1, raw}

InvestmentCumulativeTotalTag

The InvestmentCumulativeTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${investment:cumulative_total} where cumulative_total returns the cumulative total of the investment. The text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the investment.
parameter mnemonic the mnemonic of the investment.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${investment:cumulative_total, id=[investmentid]}
• ${investment:cumulative_total, mnemonic=invest1}
• ${investment:cumulative_total, id=123, scale=0.001, unit=k, dec=2}
• ${investment:cumulative_total, mnemonic=invest1, raw}

InvestmentNameTag

The InvestmentName class is applied to PowerPoint Report Templates when the following text is found in a text box: ${investment:name} where name returns the label of the investment.

parameter id the id number of the investment.
parameter mnemonic the mnemonic of the investment.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${investment:name,id=1}
• ${investment:name,id=[investmentid]} - When used inside of a duplicate slide or duplicate section tag.

InvestmentTooltipTag

The InvestmentTooltipTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${investment:tooltip,id=investmentid} where tooltip returns the tool tip of the investment.

parameter id the id number of the investment.
parameter mnemonic the mnemonic of the investment.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${investment:tooltip,id=1}
• ${investment:tooltip,id=[investmentid]} - When used inside of a duplicate slide or duplicate section tag.

InvestmentTotalTag

* The InvestmentTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${investment:invested_total} where invested_total returns the total cumulative investment. The text will be replaced in-line (as opposed to removing and replacing the container).

Optional parameter year returns year the value should return. Default is the analysis period.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${investment:invested_total}
• ${investment:invested_total, year=1}
• ${investment:invested_total, scale=0.001, unit=k, dec=2}
• ${investment:invested_total, year=1, raw}

InvestmentsIncludedTag

* The InvestmentsIncludedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${investment:investments_included} where investments_included returns true or false if the investments are included. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

• ${investment:investments_included}

KeyPerformanceIndicatorCurrentValueTag

The KeyPerformanceIndicatorCurrentValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${kpi:current_value} where current_value returns the current value of the KPI.

parameter id the id number of the KPI.
parameter mnemonic the mnemonic of the KPI.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${kpi:current_value, mnemonic=kpi1}
• ${kpi:current_value, id=7}

KeyPerformanceIndicatorNameTag

The KeyPerformanceIndicatorNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${kpi:name} where name returns the label name of the KPI.

parameter id the id number of the KPI.
parameter mnemonic the mnemonic of the KPI.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${kpi:name, mnemonic=kpi1}
• ${kpi:name, id=7}

KeyPerformanceIndicatorOriginalValueTag

The KeyPerformanceIndicatorOriginalValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${kpi:original_value} where original_value returns the original value of the KPI.

parameter id the id number of the KPI.
parameter mnemonic the mnemonic of the KPI.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${kpi:original_value, mnemonic=kpi1}
• ${kpi:original_value, id=7}

KeyPerformanceIndicatorTargetValueTag

The KeyPerformanceIndicatorTargetValueTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${kpi:target_value} where target_value returns the target value of the KPI.

parameter id the id number of the KPI.
parameter mnemonic the mnemonic of the KPI.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

See ReportTag for syntax.

Examples:

• ${kpi:target_value, mnemonic=kpi1}
• ${kpi:target_value, id=7}

KeyPerformanceIndicatorTooltipTag

The KeyPerformanceIndicatorTooltipTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${kpi:tooltip} where tooltip returns the tooltip of the KPI.

parameter id the id number of the KPI.
parameter mnemonic the mnemonic of the KPI.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${kpi:tooltip, mnemonic=kpi1}
• ${kpi:tooltip, id=7}

LabelTextTag

The LabelTextTag is currently not supported.

AnalysisLanguageCodeTag

The AnalysisLanguageCodeTag class is applied to Report Templates when the following text is found: ${language:code} where code returns the iso code of the language

See ReportTag for syntax.

Example:

• ${language:code}

AnalysisLanguageNameTag

The AnalysisLanguageNameTag class is applied to Report Templates when the following text is found: ${language:name} where name returns the name of the language

See ReportTag for syntax.

Example:

RichTextEditorHtmlTag

The RichTextEditorHtmlTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${richText:html} where html returns the user entered text (i.e. text input). If the text box is single line then the text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the rich text editor.
parameter mnemonic the mnemonic of the rich text editor.
Only one parameter is required for the tag, while the other can be omitted.

See ReportTag for syntax.

Examples:

• ${richText:html, mnemonic=rte1}
• ${richText:html, id=7}

RichTextEditorNameTag

The RichTextEditorNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${richText:name} where name returns the label name of the rich text editor (i.e. text input)

parameter id the id number of the rich text editor.
parameter mnemonic the mnemonic of the rich text editor.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${richText:name, mnemonic=kpi1}
• ${richText:name, id=7}

SelectNameTag

The SelectNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${select:name} where name returns the label name of the Select.

parameter id the id number of the Select.
parameter mnemonic the mnemonic of the Select.
Only one parameter is required for the tag, while the other can be omitted.

Optional parameter asHTML will insert the contents as formatted HTML. This option will replace the container instead of a in line replacement.

See ReportTag for syntax.

Examples:

• ${select:name, mnemonic=select1}
• ${select:name, id=7}

SelectValueIncludedTag

The SelectValueIncludedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${select:value_included} where value_included returns true if the values were selected by the user. The text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the select.
parameter mnemonic the mnemonic of the select.
Only one parameter is required for the tag, while the other can be omitted.

Required parameter values. The set of values to test if they were selected. The values require being surrounded by [] square brackets and must be semi-colon ; separated.

Optional parameter include. Determines if the tag should check if all values or any single value was selected. Accepts the following values:

• all (all matching values must be selected to return true)
• any (any of the matching values were selected to return true. Default behavior)

See ReportTag for syntax.

Examples:

• ${select:value_included, id=3, values=[option1;option2]}
• ${select:value_included, mnemonic=select3, values=[option1;option2; option3]}
• ${select:value_included, mnemonic=select3, include=all, values=[option1;option2]}
• ${select:value_included, mnemonic=select3, include=any, values=[option1;option2]}

SelectValueSelectedTag

The SelectValueSelectedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${select:value_selected} where value_selected returns the value(s) that were selected by the user. The text will be replaced in-line (as opposed to removing and replacing the container).

parameter id the id number of the select.
parameter mnemonic the mnemonic of the select.
Only one parameter is required for the tag, while the other can be omitted.

optional parameter useLabel. If set to true, will display selected options label instead of value. Defaults to false

optional parameter display. If set to list, will display selected options as a bulleted list. Defaults to inline where options are comma separated

See ReportTag for syntax.

Examples:

• ${select:value_selected, id=3}
• ${select:value_selected, mnemonic=select1}
• ${select:value_selected, mnemonic=select3, useLabel=true, display=list}

SummaryModelDurationYearsTag

The SummaryModelDurationYearsTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:duration_years} where duration_years returns the duration in years of the summary model.

Examples:

• ${summary_model:duration_years}

SummaryModelIrrTag

The SummaryModelIrrTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:irr} where irr returns the Internal rate of return of the summary model.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

See ReportTag for syntax.

Examples:

• ${summary_model:irr}

SummaryModelNpvTag

The SummaryModelNpvTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:npv} where npv returns the total Net present value of the summary model.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

See ReportTag for syntax.

Examples:

• ${summary_model:npv}

SummaryModelPaybackPeriodTag

The SummaryModelPaybackPeriodTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:payback_period} where payback_period returns the payback period in months of the summary model.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

See ReportTag for syntax.

Examples:

• ${summary_model:payback_period}

SummaryModelRoiTag

The SummaryModelRoiTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:roi} where roi returns the Return on Investment of the summary model.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

See ReportTag for syntax.

Examples:

• ${summary_model:roi}

SummaryModelTotalBenefitsRealizedTag

The SummaryModelTotalBenefitsRealizedTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:total_benefit_realized} where total_benefit_realized returns the total realized benefit of the summary model.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

See ReportTag for syntax.

Examples:

• ${summary_model:total_benefit_realized}

SummaryModelTotalInvestmentDiscountedTag

The SummaryModelTotalInvestmentDiscountedTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:total_investment_discounted} where total_investment_discounted returns the total investment with discount applied for the summary model.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

See ReportTag for syntax.

Examples:

• ${summary_model:total_investment_discounted}

SummaryModelTotalInvestmentTag

The SummaryModelTotalInvestmentTag class is applied to Report Templates when the following text is found in a text box: ${summary_model:total_investment} where total_investment returns the total investment of the summary model.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

See ReportTag for syntax.

Examples:

• ${summary_model:total_investment}

ClientFirstNameTag

The ClientFirstNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:client_first}.
It will display the client/recipient first name from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:client_first}

ClientLastNameTag

The ClientLastNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:client_last}.
It will display the client/recipient last name from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:client_last}

ClientPhoneTag

The ClientPhoneTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:client_phone}.
It will display the client/recipient phone number from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:client_phone}

ClientTitleTag

The ClientTitleTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:client_title}.
It will display the client/recipient title from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:client_title}

RepFirstNameTag

The RepFirstNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:rep_first}.
It will display the sales representative first name from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:rep_first}

RepLastNameTag

The RepLastNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:rep_last}.
It will display the sales representative last name from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:rep_last}

RepPhoneTag

The RepPhoneTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:rep_phone}.
It will display the sales representative phone number from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:rep_phone}

RepTitleTag

The RepTitleTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:rep_title}.
It will display the sales representative title from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:rep_title}

TargetEmailTag

The TargetEmailTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:target_email}.
It will display the target email from the Generate Report Modal in the application inline (as opposed to removing and replacing the container).
If targeting a custom text field instead see RichTextEditorHtmlTag

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:target_email}

UserEmailTag

The UserEmailTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:user_email}. It will display the logged in user who generated the report's email address inline (as opposed to removing and replacing the container).

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:user_email}

UserFirstTag

The UserFirstTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:user_first}. It will display the logged in user who generated the report's first name inline (as opposed to removing and replacing the container).

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:user_first}

UserLastTag

The UserLastTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:user_last}. It will display the logged in user who generated the report's last name inline (as opposed to removing and replacing the container).

There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${db:user_last}

ValueMapCategoryAnnualIdealBenefitTag

The ValueMapCategoryAnnualIdealBenefitTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:annualIdealBenefit, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the Annual ideal benefit in-line (as opposed to removing and replacing the container).

Parameter id is required. There are no optional parameters.

Below options only available in Tool builder v8+

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter year returns year the value should return. Default is year 1.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:annualIdealBenefit,id=[vmcid]}
• ${vmc:annualIdealBenefit,id=123, year=1}
• ${vmc:annualIdealBenefit,id=123, scale=0.001, unit=k, dec=2}
• ${vmc:annualIdealBenefit,id=123, year=1, raw}

ValueMapCategoryAnnualRealizedBenefitTag

The ValueMapCategoryAnnualRealizedBenefitTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:annualRealizedBenefit, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the Annual realized benefit in-line (as opposed to removing and replacing the container).

Parameter id is required. There are no optional parameters.

Below options only available in Tool builder v8+

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter year returns year the value should return. Default is year 1.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:annualRealizedBenefit,id=[vmcid]}
• ${vmc:annualRealizedBenefit,id=123, year=1}
• ${vmc:annualRealizedBenefit, id=123, scale=0.001, unit=k, dec=2}
• ${vmc:annualRealizedBenefit, id=123, year=1, raw}

ValueMapCategoryAverageIdealTotalTag

The ValueMapCategoryAverageIdealTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:average_ideal_total, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the ideal average total over the analysis period, text will be replaced in-line (as opposed to removing and replacing the container).

Parameter id is required.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:average_ideal_total, id=[vmcid]}
• ${vmc:average_ideal_total, id=123, scale=0.001, unit=k, dec=2}
• ${vmc:average_ideal_total, id=123, raw}

ValueMapCategoryAverageRealizedTotalTag

The ValueMapCategoryAverageRealizedTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:average_realized_total, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the realized average total over the analysis period, text will be replaced in-line (as opposed to removing and replacing the container).

Parameter id is required.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:average_realized_total, id=[vmcid]}
• ${vmc:average_realized_total, id=123, scale=0.001, unit=k, dec=2}
• ${vmc:average_realized_total, id=123, raw}

ValueMapCategoryCurrentTotalTag

The ValueMapCategoryCurrentTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:current_total, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the current total in-line (as opposed to removing and replacing the container).

Parameter id is required.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:current_total, id=[vmcid]}
• ${vmc:current_total, id=123, scale=0.001, unit=k, dec=2}
• ${vmc:current_total, id=123, raw}

ValueMapCategoryIdealBenefitTotalTag

The ValueMapCategoryIdealBenefitTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:ideal_Benefit_total, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the ideal benefit total in-line (as opposed to removing and replacing the container).

Parameter id is required.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:ideal_Benefit_total, id=[vmcid]}
• ${vmc:ideal_Benefit_total, id=123, scale=0.001, unit=k, dec=2}
• ${vmc:ideal_Benefit_total, id=123, raw}

ValueMapCategoryIncludedTag

The ValueMapCategoryIncludedTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:included, id=[vmcid]} where it will return true if a category was included. [vmcid] is a valid value map category id. It will display in-line (as opposed to removing and replacing the container).

Parameter id is required.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:included, id=[vmcid]}

ValueMapCategoryMultiYearTableTag

The ValueMapCategoryMultiYearTableTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:table_multi_year} where table_multi_year will return a Multi year summary of Value map categories.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter headerFg will set the foreground color of the table header to the entered Hex value.

Optional parameter headerBg will set the background color of the table header to the entered Hex value.

Optional parameter textForeGround will set the foreground color of the table rows to the entered Hex value.

Optional parameter textBackground will set the background color of the table rows to the entered Hex value.

Optional parameter subTotalFg will set the foreground color of the table subtotal rows to the entered Hex value.

Optional parameter subTotalBg will set the background color of the table subtotal rows to the entered Hex value.

Optional parameter totalFg will set the foreground color of the table total rows to the entered Hex value.

Optional parameter totalBg will set the background color of the table total rows to the entered Hex value.

Optional parameter theme will set a default background color and text color for all rows (colors overwritten by above options). Accepts the following values:

• light
• dark

Optional parameter impactType will set the values returned. Accepts the following

• realized
• ideal

Optional parameter sortBy will set the order returned. Accepts the following

• default - default display order as presented on the Benefit scope page
• name - by name order
• value - by highest value

Optional parameter type determines the type of table returned. Accepts the following values:

• category (summary of a specific category, requires an id of the value category)
• monetary (summary of only monetary categories)
• non_monetary (summary of only non monetary categories)
• overview (brief overview of both monetary/non monetary categories)

This parameter is required if targeting a specific value category.
parameter id the id number of the value map category.

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${vmc:table_multi_year, projection=Conservative}
• ${vmc:table_multi_year, type=overview}
• ${vmc:table_multi_year, type=monetary, headerFg=#E0E0E0, headerBg=#11a6c0}
• ${vmc:table_multi_year, type=category, id=1}
• ${vmc:table_multi_year, type=category, id=1, theme=dark}

ValueMapCategoryNameTag

The ValueMapCategoryNameTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:name,id=[vmcid]} where [vmcid] is a valid value map category id. It will display the value map category name inline (as opposed to removing and replacing the container).

Parameter id is required. There are no optional parameters.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:name,id=[vmcid]}
• ${vmc:name,id=123}

ValueMapCategoryProposedTotalTag

The ValueMapCategoryProposedTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:proposed_total, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the proposed total in-line (as opposed to removing and replacing the container).

Parameter id is required.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:proposed_total, id=[vmcid]}
• ${vmc:proposed_total, id=123, scale=0.001, unit=k, dec=2}
• ${vmc:proposed_total, id=123, raw}

ValueMapCategoryRealizedBenefitTotalTag

The ValueMapCategoryIdealBenefitTotalTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:realized_Benefit_total, id=[vmcid]} where [vmcid] is a valid value map category id. It will display the realized benefit total in-line (as opposed to removing and replacing the container).

Parameter id is required.

Optional parameter scale where the decimal value passed will be used to scale the displayed value

Optional parameter unit where the value set will be displayed as the unit abbreviation (e.g. K,M,B)

Optional parameter dec where the value set will overwrite the decimal precision of the displayed value

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter raw when present will return the value with no formatting. If Currency the value will be returned in USD with no symbol. Commonly meant to be used in conjuction with evaluate tags.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:realized_Benefit_total, id=[vmcid]}
• ${vmc:realized_Benefit_total, id=123, scale=0.001, unit=k, dec=2}
• ${vmc:realized_Benefit_total, id=123, raw}

ValueMapCategoryValueTableTag

The ValueMapCategoryValueTableTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${vmc:table_category_value} where table_category_value will return various value summaries for Value map categories, or various detailed summaries of a specific category.

Optional parameter projection accepts a name of a projection (e.g. Conservative, Probable, Optimistic), which the value returned is based on. Default is the users selected projection

Optional parameter sortBy will set the order returned. Accepts the following

• default - default display order as presented on the Benefit scope page
• name - by name order
• value - by highest value

Optional parameter headerFg will set the foreground color of the table header to the entered Hex value.

Optional parameter headerBg will set the background color of the table header to the entered Hex value.

Optional parameter textForeGround will set the foreground color of the table rows to the entered Hex value.

Optional parameter textBackground will set the background color of the table rows to the entered Hex value.

Optional parameter subTotalFg will set the foreground color of the table subtotal rows to the entered Hex value.

Optional parameter subTotalBg will set the background color of the table subtotal rows to the entered Hex value.

Optional parameter totalFg will set the foreground color of the table total rows to the entered Hex value.

Optional parameter totalBg will set the background color of the table total rows to the entered Hex value.

Optional parameter theme will set a default background color and text color for all rows (colors overwritten by above options). Accepts the following values:

• light
• dark

Optional parameter type determines the type of table returned. Accepts the following values:

• annual_ideal (annual ideal value summary)
• annual_realized (annual realized value summary)
• average_ideal (average ideal value summary of all years)
• average_realized (average realized value summary of all years)
• total_ideal (total ideal value summary of all years)
• total_realized (total realized value summary of all years)

This parameter is required if targeting a specific value category.
parameter id the id number of the value map category.

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

• ${vmc:table_category_value, projection=Conservative}
• ${vmc:table_category_value, type=annual_ideal}
• ${vmc:table_category_value, type=average_ideal, headerFg=#E0E0E0, headerBg=#11a6c0}
• ${vmc:table_category_value, type=average_realized, id=1}
• ${vmc:table_category_value, type=total_realized, theme=dark}

ValueMapCategoryVisibilityTag

The ValueMapCategoryVisibilityTag class is applied to Report Templates when the following text is found in a text box: ${vmc:visibility, id=[vmcid]} where it will return true if a category was visible. [vmcid] is a valid value map category id. It will display in-line (as opposed to removing and replacing the container).

Parameter id is required.

The tag is case-insensitive.

See ReportTag for syntax.

Example:

• ${vmc:visibility, id=[vmcid]}
• ${vmc:visibility, id=123}