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.
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}
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
nrtag.
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.
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}
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}
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 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}
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}
Tag is an alias, see
DocItemTableIdTag for
more information.
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}
Tag is an alias, see
DocItemTableNameTag for
more information.
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}
Tag is an alias, see
DocItemTableVisibilityTag for
more information.
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.
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:
${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.
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}
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}
DocCurrencyIsoCodeTag
The DocCurrencyIsoCodeTag class is applied to Word 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:name}
DocCurrencyNameTag
The DocCurrencyNameTag class is applied to Word 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}
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 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}
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
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}
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 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}
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
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}
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
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}
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.
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}
DocCodnQuarterlyTag
* The DocCodnQuarterlyTag class is applied to Word 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}
DocCodnTag
* The DocCodnTag class is applied to Word 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}
DocCompanyNameTag
* The DocCompanyNameTag class is applied to Word 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}
DocCumulativeBenefitByYearTag
* The DocCumulativeBenefitByYearTag class is applied to Word
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}
DocCumulativeBenefitTag
The DocCumulativeBenefitTag class is applied to Word 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}
DocCumulativeNetBenefitByYearTag
* The DocCumulativeNetBenefitByYearTag class is applied to Word
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}
DocCumulativeNetBenefitTag
The DocCumulativeNetBenefitTag class is applied to Word 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}
DocCurrentProjectionTag
* The DocCurrentProjectionTag class is applied to Word 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}
DocDeploymentPeriodTag
The DocDeploymentPeriodTag class is applied to Word 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}
DocDirectBenefitRealizationTag
The DocDirectBenefitRealizationTag class is applied to Word Report Templates when the
following text is found in a text box:
${calc:direct_benefit_realization} where direct_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:direct_benefit_realization}
DocDiscountRateTag
The DocDiscountRateTag class is applied to Word 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}
DocIdealImpactByYearTag
Report tag handler for: ${analysis:ideal_impact_by_year} Returns a breakdown of total ideal impact values by year. Supports optional "projection" parameter. Example usage: - ${analysis:ideal_impact_by_year} - ${analysis:ideal_impact_by_year, projection=Probable}
DocIndirectBenefitRealizationTag
The DocIndirectBenefitRealizationTag class is applied to Word 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}
DocIndustryTag
* The DocIndustryTag class is applied to Word 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}
DocIrrTag
* The DocIrrTag class is applied to Word 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}
DocLocationTag
* The DocLocationTag class is applied to Word 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}
DocNetBenefitByYearTag
* The DocNetBenefitByYearTag class is applied to Word
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}
DocNpvTag
The DocNpvTag class is applied to Word 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}
DocPaybackTag
* The DocPaybackTag class is applied to Word 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}
DocPotentialBenefitTag
The DocPotentialBenefitTag class is applied to Word 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}
DocRoiPerYearTag
The DocRoiPerYearTag class is applied to Word 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}
DocRoiTag
* The DocRoiTag class is applied to Word 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}
DocSimpleRealizationByYearTag
The DocSimpleRealizationByYearTag class is applied to Word 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}
DocTemplateModeTag
The DocTemplateModeTag class is applied to Word 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}
DocTotalDirectBenefitsTag
The DocTotalDirectBenefitsTag class is applied to Word 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}
DocTotalIndirectBenefitsTag
* The DocTotalIndirectBenefitsTag class is applied to Word 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}
DocTotalRealizedBenefitsTag
The DocTotalRealizedBenefitsTag class is applied to Word 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}
DocBenefitAnnualGrowthRateTag
* The DocBenefitAnnualGrowthRateTag class is applied to Word
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}
DocBenefitAverageIdealTotalTag
The DocBenefitAverageIdealTotalTag class is applied to Word 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}
DocBenefitAverageRealizedTotalTag
The DocBenefitAverageRealizedTotalTag class is applied to Word 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}
DocBenefitBenefitTextTag
* The DocBenefitBenefitTextTag class is applied to Word
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}
DocBenefitCalcTableTag
The DocBenefitCalcTableTag class is applied to Word 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
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}
DocBenefitCalloutTag
The DocBenefitCalloutTag class is applied to Word 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}
DocBenefitChallengeTextTag
* The DocBenefitChallengeTextTag class is applied to Word 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}
DocBenefitComprehensiveRealizationTag
* The DocBenefitComprehensiveRealizationTag class is applied to Word 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}
DocBenefitDeploymentTimeTag
* The DocBenefitDeploymentTimeTag class is applied to Word 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}
DocBenefitDescriptionTag
* The DocBenefitDescriptionTag class is applied to Word 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}
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}
DocBenefitIdByRankTag
The DocBenefitIdByRankTag class is applied to Word 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}
DocBenefitImpactRealizedTag
The DocBenefitImpactRealizedTag class is applied to Word 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}
DocBenefitImpactUnrealizedTag
* The DocBenefitImpactUnrealizedTag class is applied to Word 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}
DocBenefitIsIncludedTag
* The DocBenefitIsIncludedTag class is applied to Word 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}
DocBenefitLineItemTag
The DocBenefitLineItemTag class is applied to Word 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}
DocBenefitNameTag
* The DocBenefitNameTag class is applied to Word 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.
See ReportTag for syntax.
Examples:
${benefit:name, mnemonic=benefit1}${benefit:name, id=7}
DocBenefitProposedTotalTag
The DocBenefitProposedTotalTag class is applied to Word 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}
DocBenefitQuarterlySummaryTableTag
The DocBenefitQuarterlySummaryTableTag class is applied to Word
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}
DocBenefitRealizationByYearTag
The DocBenefitRealizationByYearTag class is applied to Word 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}
DocBenefitRealizationTableTag
The DocBenefitRealizationTableTag class is applied to Word 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}
DocBenefitTotalRealizedImpactTag
The DocBenefitTotalRealizedImpactTag class is applied to Word 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}
DocBenefitValueTotalTag
* The DocBenefitValueTotal class is applied to Word 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}
DocChallengeNameTag
* The DocChallengeNameTag class is applied to Word 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.
See ReportTag for syntax.
Examples:
${challenge:name, id=3}${challenge:name, mnemonic=challenge3}
DocChallengeTooltipTag
The DocChallengeTooltipTag 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.
See ReportTag for syntax.
Examples:
${challenge:tooltip, id=3}${challenge:tooltip, mnemonic=challenge3}
DocChallengeValueTag
* The DocChallengeValueTag class is applied to Word 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}
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}
DocEvaluateAndTag
The DocEvaluateAndTag class is applied to Word 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
DocSelectValueIncludedTag
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}]}
DocEvaluateEqualsTag
The DocEvaluateEqualsTag class is applied to Word 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}
DocEvaluateGreaterThanTag
The DocEvaluateGreaterThanTag class is applied to Word 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}
DocEvaluateLessThanTag
The DocEvaluateLessThanTag class is applied to Word 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}
DocEvaluateNotEqualsTag
The DocEvaluateNotEqualsTag class is applied to Word 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}
DocEvaluateOrTag
The DocEvaluateOrTag class is applied to Word 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
DocSelectValueIncludedTag
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}]}
DocGlobalVairableLabelTag
The DocGlobalVariableLabelTag class is applied to Word 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.
See ReportTag for syntax.
Examples:
${global:label, mnemonic=gv1}${global:label, id=7}
DocGlobalVariableCurrentValueTag
The DocGlobalVariableCurrentValueTag class is applied to Word 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}
DocGlobalVariableImpactValueTag
The DocGlobalVariableImpactValuetag class is applied to Word 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
DocBenefitLineItemTag
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}
DocGlobalVariableProposedValueTag
The DocGlobalVariableProposedValueTag class is applied to Word 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
DocBenefitLineItemTag
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}
DocGlobalVariableTooltipTag
The DocGlobalVariableTooltipTag 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.
See ReportTag for syntax.
Examples:
${global:tooltip, mnemonic=gv1}${global:tooltip, id=7}
DocInvestmentAnnualTotalTag
The DocInvestmentAnnualTotalTag class is applied to Word 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}
DocInvestmentAnnualValueTag
The DocInvestmentAnnualValueTag class is applied to Word 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}
DocInvestmentCumulativeTotalTag
The DocInvestmentCumulativeTotalTag class is applied to Word
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}
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.
DocInvestmentTooltipTag
The DocInvestmentTooltipTag class is applied to Word 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.
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.
DocInvestmentTotalTag
The DocInvestmentTotalTag class is applied to Word 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}
DocInvestmentsIncludedTag
* The DocInvestmentsIncludedTag class is applied to Word 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}
DocKeyPerformanceIndicatorCurrentValueTag
The DocKeyPerformanceIndicatorCurrentValueTag class is applied to
Word 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}
DocKeyPerformanceIndicatorNameTag
The DocKeyPerformanceIndicatorNameTag class is applied to Word 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.
See ReportTag for syntax.
Examples:
${kpi:name, mnemonic=kpi1}${kpi:name, id=7}
DocKeyPerformanceIndicatorOriginalValueTag
The DocKeyPerformanceIndicatorOriginalValueTag class is applied to
Word 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}
DocKeyPerformanceIndicatorTargetValueTag
The DocKeyPerformanceIndicatorTargetValueTag class is applied to Word
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}
DocKeyPerformanceIndicatorTooltipTag
The DocKeyPerformanceIndicatorTooltipTag class is applied to Word
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.
See ReportTag for syntax.
Examples:
${kpi:tooltip, mnemonic=kpi1}${kpi:tooltip, id=7}
DocAnalysisLanguageCodeTag
The DocAnalysisLanguageCodeTag 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}
DocAnalysisLanguageNameTag
The DocAnalysisLanguageNameTag 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:
DocRichTextEditorHtmlTag
The DocRichTextEditorHtmlTag class is applied to Word 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).
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}
DocRichTextEditorNameTag
The DocRichTextEditorNameTag class is applied to Word 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.
See ReportTag for syntax.
Examples:
${richText:name, mnemonic=kpi1}${richText:name, id=7}
DocSelectNameTag
The DocSelectNameTag class is applied to Word 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.
See ReportTag for syntax.
Examples:
${select:name, mnemonic=select1}${select:name, id=7}
DocSelectValueIncludedTag
The DocSelectValueIncludedTag class is applied to Word 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]}
DocSelectValueSelectedTag
The DocSelectValueSelectedTag 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}
DocClientFirstNameTag
The DocClientFirstNameTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:client_first}
DocClientLastNameTag
The DocClientLastNameTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:client_last}
DocClientPhoneTag
The DocClientPhoneTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:client_phone}
DocClientTitleTag
The DocClientTitleTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:client_title}
DocRepFirstNameTag
The DocRepFirstNameTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:rep_first}
DocRepLastNameTag
The DocRepLastNameTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:rep_last}
DocRepPhoneTag
The DocRepPhoneTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:rep_phone}
DocRepTitleTag
The DocRepTitleTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:rep_title}
DocTargetEmailTag
The DocTargetEmailTag class is applied to Word 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
DocRichTextEditorHtmlTag
There are no optional parameters.
The tag is case-insensitive.
See ReportTag for syntax.
Example:
${db:target_email}
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 logged in user who generated the reports
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 logged in user who generated the reports
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 logged in user who generated the reports
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 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}
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.
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}
DocValueMapCategoryAverageIdealTotalTag
The DocValueMapCategoryAverageIdealTotalTag class is applied to Word
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}
DocValueMapCategoryAverageRealizedTotalTag
The DocValueMapCategoryAverageIdealTotalTag class is applied to Word
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}
DocValueMapCategoryCurrentTotalTag
The DocValueMapCategoryCurrentTotalTag class is applied to Word
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}
DocValueMapCategoryIdealBenefitTotalTag
The DocValueMapCategoryIdealBenefitTotalTag class is applied to
Word 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}
DocValueMapCategoryIncludedTag
The DocValueMapCategoryIncludedTag class is applied to Word 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]}
DocValueMapCategoryMultiYearTableTag
The DocValueMapCategoryMultiYearTableTag class is applied to Word
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}
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}
DocValueMapCategoryProposedTotalTag
The DocValueMapCategoryProposedTotalTag class is applied to Word
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}
DocValueMapCategoryRealizedBenefitTotalTag
The DocValueMapCategoryRealizedBenefitTotalTag class is applied to
Word 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}
DocValueMapCategoryValueTableTag
The DocValueMapCategoryValueTableTag class is applied to Word 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
- 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}
DocValueMapCategoryVisibilityTag
The DocValueMapCategoryVisibilityTag 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}