Executive Summary Parameters

Executive Summary Parameters

Within the Executive Summary Outlines, parameters (merge fields) can be used to auto-fill project data within executive summaries. These are highlighted in yellow in the text editor.


To insert a new parameter:

  1. Within the text editor, type "{{".
  2. Select the parameter you would like to add. These options are sorted in alphabetical order. As you continue typing, the options will filter accordingly.
  3. Or, if you know the exact parameter you would like to use, you can type it directly into the text editor.

Parameter Options

Parameter
Displayed Value
assessment.date
The date of the assessment (mm-dd-yyyy)
assessment.facilitator
The name of the assessment facilitator
assessment.longDate
The date of the assessment (Month d, yyyy)
assessment.lowDefinitionLevelCritieria
The minimum level to include in Summary of Gaps or Low Definition Elements
assessment.manager
The name of the assessment project manager
assessment.state
The state of the assessment (i.e., created, published)
assessment.status
The status of the assessment (i.e., Concept, Design)
assessmentType.name
The name of the assessment type (i.e., PDRI, CRA, COR)
company.name
The name of the company
company.supportAdminEmail
The email of the company's Support Admin
gate.name
The name of the gate (i.e., 1, 2, 2i, 3)
portfolio.name
The name of the portfolio that the project is within
project.ClientId
The ID of the Client 
project.clientName
The name of the Client
project.projectID
The ID of the project 
project.projectLocation
The location of the project
project.projectName
The name of the project
project.projectType
The type of the project 
status.name
The status of the assessment (i.e., Feasibility, Design, Commissioning)
template.description
The description of the template
template.name
The name of the template
template.version
The version of the template (i.e., V4.0, V4.1, V5.0)
templateType.name
The name of the template type 
insight.name
The name of the insight entity
insight.companyAvg
The company average for an insight
insight.description
The description for an insight (all information in the insight comment box)
insight.industryAvg
The industry average for an insight
insight.graph
The graph for an insight
insight.graph2
The optional secondary graph for an insight (i.e., Maturity graph)
insight.value
The value for an insight (insight score)
#score.overall
The overall insight (PDRI score when assessment type is PDRI)
#score.maturity
The maturity insight
#score.hasMaturity
True if there is a maturity insight 
#score.sections
The section insights
#score.hasSections
True if there are section insights
#score.categories
The category insights
#score.hasCategories
True if there are categories insights
#score.elements
The element insights
#score.hasElements
True if there are element insights
#accuracy.overall
The overall accuracy insight
#accuracy.categories
The accuracy category insights

Executive Summary Sections

Sections are used to display content enclosed within a start statement, "{{#", and end statement, "{{/". Sections have the ability to cycle through a list of data associated to a parameter.

Valency uses a "{{#__.has__}}" format to serve as an 'if statement'–like section that shows content only when the "{{#__.has__}}" condition returns true. 

To create a section: 
  1. Create a "{{#__.has__}}" section to display information only if the assessment contains data pertaining to the chosen parameter.
  2. Insert any information to be included when the "{{#__.has__}}" condition is fulfilled. Close the 'if-statement' section with a "{{/__.has__}}" statement.
  1. In the 'if-statement' section, open a sub-section to cycle through using a "{{#" statement and close it with a "{{/". 
  1. Populate the sub-section using any parameters or text that will be repeatedly displayed with each unique data piece linked to that parameter. In the Insights example presented in the photos, every insight selected would display in the executive summary following the same format seen in the template. 

  1. Create and populate any additional sections or sub-sections.
  2. Ensure each section is closed with a "{{/".

Section Parameter Options

ParameterDisplayed Value
#score.overallThe overall insight
#score.maturityThe maturity insight
#score.hasMaturityTrue of there is a maturity insight 
#score.sectionsThe section insights
#score.hasSectionsTrue if there are section insights
#score.categoriesThe category insights
#score.hasCategoriesTrue if there are categories insights
#score.elementsThe element insights
#score.hasElementsTrue if there are element insights
#accuracy.overallThe overall accuracy insight
#accuracy.categoriesThe accuracy category insights
    • Related Articles

    • Customize the Executive Summary Outlines

      Admin users can now create company-wide Executive Summary outlines to ensure consistent Summary Reports are created for all projects. Default outlines are provided based on industry best practice and Valency expert guidance. Accessing the Outlines To ...
    • Generating an Executive Summary

      Before generating your Executive Summary, ensure that your Insights have been properly reviewed and selected. Please see the How to Use Insights article for more details on this pre-requisite step. Creating the Executive Summary To create your ...
    • How to Use Insights

      From the Prepare mode of an Assessment, navigate to the Insights page. Please find an instructions box at the top of the Insights page. Click on the blue highlighted 'Instructions' to show or hide the basic steps on how to use Insights. Insights Tab ...
    • What is Carve Hybrid Intelligence?

      Carve Hybrid Intelligence utilizes Human Intelligence and Artificial Intelligence (AI) to create better insights from your project assurance assessments. Carve Hybrid Intelligence combines knowledge from project assurance experts, current industry ...