Report Tag Library - Word | Output Reports

Report Tag

The ReportTag class is used to parse tags used in Value360 reports. Each tag consists of a name, value, and list of attributes in the following format:

${name:value,attribute,attribute=value}

:value is not required, and other parameters can consist of an attribute=value or only an attribute depending on the specific tag.

Attributes are separated by commas with or without leading and trailing spaces.

All tags and parameters are case-insensitive.

DocBenefitIconTag

The BenefitIconTag class is applied to Word 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}

DocCustomImageTag

* The DocCustomImageTag class is applied to Word 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.

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}

DocDuplicateSectionsTag

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

Optional parameter numsections is the number of sections 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 sections 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

in a section that is duplicated, will be replaced with

${nr:DBB1234_Overview_Name} Page 1

, which will then be processed by the

nr

tag.

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

When investment sections 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 section for each value map category.
${duplicate:investments} - Duplicates one section for each investment.
${duplicate:benefits,numsections=2} - Duplicates 2 sections for each benefit.
${duplicate:benefits, numsections=2, filter=monetary, top=3} - Duplicates 2 sections for the top 3 benefits that is monetary.
${duplicate:sections} - Duplicates one section for each tool section.
${duplicate:vmcs, filter=Non_monetary} - Duplicates one section for each value map that is non monetary.

DocHideShowRowTag

The DocHideShowRowTag class is applied to Word Report Templates when the following text is found in a table cell: ${hsRow:namedRange} where namedRange is a named range that has the value no, off, false, 0, excluded, hide when you would like the row hidden.

There are no optional parameters.

The tag is case-insensitive.

This tag is only compatible with Tool Builder versions up to v7.6

See ReportTag for syntax.

Examples:

${hsRow:hide_benefit_row}

DocHighChartTag

The DocHighChartTag class is applied to Word Report Templates when the following text is found in a text box: ${chart:chart_name} where chart_name is the id of the image used in the tool. The text box will be removed and replaced with the image.

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}

DocInvestmentNameTag

The DocInvestmentNameTag class is applied to Word Report Templates when the following text is found in a text box: ${investment:name,id=investmentid} where investmentid is a valid investment id. It will display the investment name inline (as opposed to removing and replacing the container).

Parameter id is required. There are no optional parameters.

Optional parameter asHTML will insert the contents as formatted HTML.

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

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

DocNamedRangeTag

The DocNamedRangeTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${nr:named_range} where named_range is the named range that you would like to display. The text will be replaced inline (as opposed to removing and replacing the container).

Optional parameter asHTML will insert the contents as formatted HTML.

The tag is case-insensitive.

This tag is only compatible with Tool Builder versions up to v7.6

See ReportTag for syntax.

Examples:

${nr:company_name}
${nr:industry}
${nr:DBB[benefitid]_ChallengesText_report,asHTML}

DocShowSection

The DocShowSection class is applied to Word Report Templates when the following text is found in a section: ${showSection:named_range} where named_range is a named range that has the value no, off, false, 0, excluded, hide when you would like the section hidden.

Optional parameter eq. If the eq parameter is used, the tag will check if the value of the named range against the parameter's value. If the values are equal, the section will be hidden. The values are case-insensitive.

Optional parameter neq. If the neq parameter is used, the tag will check if the value of the named range against the parameter's value. If the values are not equal, the section will be hidden. The values are case-insensitive.

This tag is only compatible with Tool Builder versions up to v7.6

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

${showSection:hide_title_section}
${showSection:some_named_range}
${showSection:industry, eq=hospitality}
${showSection:industry, neq=aerospace}

DocTableTag

The DocTableTag class is applied to Word 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.

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.

The tag is case-insensitive.

See ReportTag for syntax.

Examples:

${table:multi-year-benefits__table__benefits-by-year}
${table:investment__table__annual-investment-by-category, headerFg=#E0E0E0, headerBg=#11a6c0}
${table:investment__table__annual-investment-by-category}

DocUserEmailTag

The DocUserEmailTag class is applied to Wrod Report Templates when the following text is found in a text box: ${db:user_email}. It will display the 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}

DocUserFirstTag

The DocUserFirstTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:user_first}. It will display the 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}

DocUserLastTag

The DocUserLastTag class is applied to PowerPoint Report Templates when the following text is found in a text box: ${db:user_last}. It will display the 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}

DocValueMapCategoryAnnualIdealBenefitTag

The DocValueMapCategoryAnnualIdealBenefitTag class is applied to Word 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 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 year returns year the value should return. Default is year 1.

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}

DocValueMapCategoryAnnualRealizedBenefitTag

The DocValueMapCategoryAnnualRealizedBenefitTag class is applied to Word 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 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 year returns year the value should return. Default is year 1.

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}

DocValueMapCategoryNameTag

The DocValueMapCategoryNameTag class is applied to Word 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}

DocCurrentDateTag

* The DocCurrentDateTag class is applied to Word 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}

DocItemTableIdTag

* The DocItemTableId class is applied to Word Report Templates when the following text is found in a text box: ${itemTable:id} where id returns the label name of the item table. This is typically nested in a table tag.

Required parameter mnemonic the mnemonic of the item table.

See ReportTag for syntax.

Examples:

${itemTable:id,mnemonic=myMnemonic}

DocItemTableNameTag

* The DocItemTableNameTag class is applied to Word 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}

DocItemTableVisibilityTag

* The DocItemTableVisibilityTag class is applied to Word 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}

DocLeadCaptureFieldValueTag

The DocLeadCaptureFieldValueTag class is applied to Word 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}

DocSectionIdTag

* The DocSectionId class is applied to Word Report Templates when the following text is found in a text box: ${section:id} where id returns the label name of the section. This is typically nested in a table tag.

Required parameter mnemonic the mnemonic of the section.

See ReportTag for syntax.

Examples:

${section:id,mnemonic=myMnemonic}

DocSectionNameTag

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

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

See ReportTag for syntax.

Examples:

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

DocSectionVisibilityTag

* The DocSectionVisibilityTag class is applied to Word Report Templates when the following text is found in a text box: ${section:visibility} where visibility returns true or false if the section was visible in the application.

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

See ReportTag for syntax.

Examples:

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

DocShowColumnIf

The DocShowColumnIf class is applied to Word 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}

DocShowIf

* The DocShowIf class is applied to Word Report Templates when the following text is found in a text box: ${showIf:{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 section.

See ReportTag for syntax.

Examples:

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

DocShowRowIf

* The DocShowRowIf class is applied to Word 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.

See ReportTag for syntax.

Examples:

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

DocTIckboxTickedTag

* The DocTIckboxTickedTag class is applied to Word 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}

DocTickboxNameTag

The DocTickboxNameTag class is applied to Word 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.

See ReportTag for syntax.

Examples:

${tickbox:name, mnemonic=tickbox1}

DocTickboxTooltipTag

The DocTickboxTooltipTag 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.

See ReportTag for syntax.

Examples:

${tickbox:tooltip, mnemonic=tickbox1}

DecTemplateNameTag

* The DecTemplateNameTag class is applied to Word 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 analysiss. The text will be replaced in-line (as opposed to removing and replacing the container).

See ReportTag for syntax.

Examples:

${template:name}

DocAnalysisPeriodTag

* The DocAnalysisPeriodTag class is applied to Word 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}

DocAnnualGrowthRateTag

The DocAnnualGrowthRateTag class is applied to Word 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}

DocAvgAnnualBenefitsTag

* The DocAvgAnnualBenefitsTag class is applied to Word 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 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 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:avg_ann_benefits}
${calc:avg_ann_benefits, projection=Probable, scale=0.001, unit=k}

DocBenefitCurrentSumTotalOverPeriodTag

The DocBenefitCurrentSumTotalOverPeriodTag class is applied to Word 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

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}

DocBenefitCurrentSumTotalTag

The DocBenefitCurrentSumTotalTag class is applied to Word 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 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

See ReportTag for syntax.

Examples:

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

DocBenefitProposedSumTotalOverPeriodTag

The DocBenefitProposedSumTotalOverPeriodTag class is applied to Word 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

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}

DocBenefitProposedSumTotalTag

The DocBenefitProposedSumTotalTag class is applied to Word 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

See ReportTag for syntax.

Examples:

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

DocCashFlowTableTag

The DocCashFlowTableTag class is applied to Word 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.