Configuring a Report Generator component for Microsoft Word and PowerPoint

The Alt Text field provided in Microsoft Office is used to configure the Report Generator "components":

  • Report Generator will search within the Office document for text boxes, graphs and tables
  • When one of these items is located, it will read the Alt Text value that is used for declaring the component

The syntax for configuring a placeholder is as follows:

<COMPONENT_TYPE>;<COMPONENT_ID>;<PARAM1NAME>=<PARAM1_VALUE>,<PARAM2_NAME>=<PARAM2_VALUE>,...


  • No carriage return is accepted in this syntax, as this can cause errors
  • COMPONENT_TYPE : can be TEXT, GRAPH or TABLE
  • COMPONENT_ID : see the one you need in the

    components list


    Some parameters are mandatory others are not. Refer to the components list to see which parameters are expected for which component

How to access component definitions in Microsoft Word

You can copy/paste each object placeholder by selecting the full content, then you just have to modify Alt Text configuration to fit to your needs.

Text placeholders

Versions prior to Office 365

Select the text box and right click to access the contextual menu. Then select Format Shape. In the Format Shape menu: Shape Options > Layout & Properties > Alt Text: fill in the Description field with the component options.

Office 365 versions

Select the text box and right click to access the contextual menu. Then select Edit Alt Text. If you can't find this command, you can search for Display the Alt Text Pane after having selected the text box. This command can be added to the Quick Access toolbar in Word.

Graph placeholders

Versions prior to Office 365

Select the chart, and right click to access the contextual menu. Then select Format Chart Area. In the Format Chart Area menu: Chart Options > Layout & Properties > Alt Text: fill in the Description field with the component options.

Office 365 versions

Similar to text placeholders, select the chart and right click to access the contextual menu. Then select Edit Alt Text. If you can't find this command, you can search for Display the Alt Text Pane after having selected the chart.

Table placeholders

Select the table and right click to access the contextual menu. Then select Table Properties. In the Alt Text tab, fill in the Description field.

How to access component definitions in Microsoft PowerPoint

In Microsoft PowerPoint, Text, Graph and Tables are configured in the same way as in Microsoft Word.

Versions prior to Office 365

To see the alternative text property of all components, you should activate the Size and Position  button in PowerPoint properties:

Click to enlarge

A new button will now be available alongside the Save and Undo/Redo buttons as shown below. This button gives you the possibility to access to the alternative text property of all components:

Now you can select a Shape and edit the alternative text property value:

Office 365 versions

As with Microsoft Word, in Office 365, the Alt Text is no longer displayed in the Size and Positions pane. To access it, select the object and in the right-click contextual menu, select Edit Alt Text:

If you can't find the Edit Alt Text command in the contextual menu, you can search for Display the Alt Text Pane after having selected the object:

You can also customize the quick access toolbar with this command:

How to configure components in Microsoft Excel

The general syntax for placeholders in Microsoft Excel is:

"RepGen:" prefix + block type (TEXT or TABLE, GRAPH is not supported) + block name and parameters

For instance, the application name can be retrieved using:

"RepGen:TEXT;APPLICATION_NAME"

Limitation: in tables for excel reports, the performances of generating the report can be very bad when there are more than 10000 rows to insert in a worksheet. So prefer to limit the components results with the COUNT option set to 5000 and not -1 to keep good performances.

Components list

Text components Text components available for Report Generator 1.25
Graph components Graph components for Report Generator 1.25
Table components Table components for Report Generator 1.25
Generic components

Generic components in Report Generator 1.25

All the "fantastic" things you can do with generic components for graphs and tables (GENERIC_GRAPH and GENERIC_TABLE)

Where to find some examples and predefined reports

In 1.12.0 version, the reports templates location management has changed. When the RG is installed, there is still a folder Templates that is created, but it has been reviewed : 

  • the Application sub folder contains the hierarchy of templates that are used in application mode
    • the "Application\Component library" folder contains the example for all the application components
    • the "Application\Compliance reports" contains the security reports regarding quality standards
    • the "Application\Sizing reports" contains the reports concerning Function Points and AEP
    • the "Application\Legacy report" contains the old reports from Report Generator
  • the Portfolio sub folder contains the hierarchy of templates that are used in portfolio mode
    • the "Portfolio\Portfolio component library" folder contains the example for all the portfolio components
  • the "zh-Hans" sub folder contains Portfolio and Application sub folders that are used when culture is set to Chinese.

The Report Generator now display the hierarchy of folders for each mode and you can navigate through this hierarchy to find the desire template. The command line is also able to find the template by its name in this hierarchy (no need to give the entire path). User is free to add its own templates in this hierarchy, and he can create subfolders inside Application and Portfolio folders, they will be seen in the tree view. If user want to change the settings and update the root folder for the templates, he should not forget to locate his templates in sub folders Application and Portfolio (depending on their use). If not, the Report Generator will not be able to find his templates.

Sample reports dependencies with CAST-RESTAPI and Quality Standard Mapping extension

Those reports can only be generated on an application domain.

Requirements

  • CAST-RESTAPI >= 2.4.0
  • Quality standards mapping extension >= 20240212.0.0-funcrel

  • CISQ index extension >= 20240201.0.0-funcrel

  • ISO-5055 index extension >= 20240202

  • Security Standards extension >= 20240209.0.0-funcrel

  • OMG Automated or Contextual Technical Debt Measure >= 2.0.0-funcrel

Templates

LocationReport NameStatus
Portfolio\Portfolio component library1- Portfolio-Powerpoint-components-library.pptx
Portfolio\Portfolio component library2- Porftolio-Word-components-library.docx
Portfolio\Portfolio component libraryPortfolio Generic Graph Definition.docx
Portfolio\Portfolio component libraryPortfolio Generic Table Definition.pptx
Application\Component library1- Powerpoint-components-library.pptx Updated
Application\Component library2- Word-components-library.docx Updated
Application\Component library3- Excel-components-library.xlsx Updated
Application\Component libraryGeneric Graph Definition.docx
Application\Component libraryGeneric Graph Definition.pptx
Application\Component libraryGeneric Table Definition.docx
Application\Component libraryGeneric Table Definition.pptx
Application\Compliance reportsC-CPP Standards Compliance Report.docx
Application\Compliance reportsC-CPP Standards Detailed Report.docx
Application\Compliance reportsC-CPP Standards Full Detailed Report.xlsx
Application\Compliance reportsCWE (2011) Top 25 Compliance Report.docx
Application\Compliance reportsCWE (2011) Top 25 Detailed Report.docx
Application\Compliance reportsCWE (2011) Top 25 Full Detailed Report.xlsx
Application\Compliance reportsCWE (2019) Top 25 Compliance Report.docx
Application\Compliance reportsCWE (2019) Top 25 Detailed Report.docx
Application\Compliance reportsCWE (2019) Top 25 Full Detailed Report.xlsx
Application\Compliance reportsCWE (2020) Top 25 Compliance Report.docx
Application\Compliance reportsCWE (2020) Top 25 Detailed Report.docx
Application\Compliance reportsCWE (2020) Top 25 Full Detailed Report.xlsx
Application\Compliance reportsCWE (2021) Top 25 Compliance Report.docx
Application\Compliance reportsCWE (2021) Top 25 Detailed Report.docx
Application\Compliance reportsCWE (2021) Top 25 Full Detailed Report.xlsx
Application\Compliance reportsCWE (2022) Top 25 Compliance Report.docx
Application\Compliance reportsCWE (2022) Top 25 Detailed Report.docx
Application\Compliance reportsCWE (2022) Top 25 Full Detailed Report.xlsx
Application\Compliance reports CWE (2023) Top 25 Compliance Report.docx New
Application\Compliance reports CWE (2023) Top 25 Detailed Report.docx New
Application\Compliance reports CWE (2023) Top 25 Full Detailed Report.xlsx New
Application\Compliance reportsCWE Compliance Report.docx
Application\Compliance reportsCWE Detailed Report.docx
Application\Compliance reportsCWE Full Detailed Report.xlsx
Application\Compliance reportsISO-5055 Compliance Report.docx
Application\Compliance reportsISO-5055 Detailed Report.docx
Application\Compliance reportsISO-5055 Full Detailed Report.xlsx
Application\Compliance reportsISO-5055 Compliance Report - OMG Technical Debt.docx
Application\Compliance reportsISO-5055 Detailed Report - OMG Technical Debt.docx
Application\Compliance reportsISO-5055 Full Detailed Report - OMG Technical Debt.xlsx
Application\Compliance reportsMIPS Reduction Compliance Report.docx
Application\Compliance reportsMIPS Reduction  Detailed Report.docx
Application\Compliance reportsMIPS Reduction  Full Detailed Report.xlsx
Application\Compliance reportsNIST-SP800-53R4 Compliance Report.docx
Application\Compliance reportsNIST-SP800-53R4 Detailed Report.docx
Application\Compliance reportsNIST-SP800-53R4 Full Detailed Report.xlsx
Application\Compliance reportsOMG-ASCQM Compliance Report.docx
Application\Compliance reportsOMG-ASCQM Detailed Report.docx
Application\Compliance reportsOMG-ASCQM Full Detailed Report.xlsx
Application\Compliance reportsOMG-ASCQM Security Compliance Report.docx
Application\Compliance reportsOMG-ASCQM Security Detailed Report.docx
Application\Compliance reportsOMG-ASCQM Security Full Detailed Report.xlsx
Application\Compliance reportsOWASP-2013 Compliance Report.docx
Application\Compliance reportsOWASP-2013 Detailed Report.docx
Application\Compliance reportsOWASP-2013 Full Detailed Report.xlsx
Application\Compliance reportsOWASP-2017 Compliance Report.docx
Application\Compliance reportsOWASP-2017 Detailed Report.docx
Application\Compliance reportsOWASP-2017 Full Detailed Report.xlsx
Application\Compliance reportsOWASP-API-2019 Compliance Report.docx
Application\Compliance reportsOWASP-API-2019 Detailed Report.docx
Application\Compliance reportsOWASP-API-2019 Full Detailed Report.xlsx
Application\Compliance reportsOWASP-API-2021 Compliance Report.docx
Application\Compliance reportsOWASP-API-2021 Detailed Report.docx
Application\Compliance reportsOWASP-API-2021 Full Detailed Report.xlsx
Application\Compliance reportsOWASP-Mobile-2016 Compliance Report.docx
Application\Compliance reportsOWASP-Mobile-2016 Detailed Report.docx
Application\Compliance reportsOWASP-Mobile-2016 Full Detailed Report.xlsx
Application\Compliance reportsPCI-DSS-V3.1 ComplianceReport.docx Fixed summary table
Application\Compliance reportsPCI-DSS-V3.1 Detailed Report.docx Fixed summary table
Application\Compliance reportsPCI-DSS-V3.1 Full Detailed Report.xlsx Fixed summary table
Application\Compliance reportsPCI-DSS-V3.2.1 ComplianceReport.docx Fixed summary table
Application\Compliance reportsPCI-DSS-V3.2.1 Detailed Report.docx Fixed summary table
Application\Compliance reportsPCI-DSS-V3.2.1 Full Detailed Report.xlsx Fixed summary table
Application\Compliance reports PCI-DSS-V4 ComplianceReport.docx New
Application\Compliance reports PCI-DSS-V4 Detailed Report.docx New
Application\Compliance reports PCI-DSS-V4 Full Detailed Report.xlsx New
Application\Compliance reportsSTIG V4R8 Compliance Report.docx 
Application\Compliance reportsSTIG V4R8 Detailed Report.docx 
Application\Compliance reportsSTIG V4R8 Full Detailed Report.xlsx 
Application\Compliance reportsSTIG V5 Compliance Report.docx
Application\Compliance reportsSTIG V5 Detailed Report.docx
Application\Compliance reportsSTIG V5 Full Detailed Report.xlsx
Application\Legacy reportsCISQ Compliance Report.docxLegacy
Application\Legacy reportsCISQ Detailed Report.docxLegacy
Application\Legacy reportsCISQ Full Detailed Report.xlsxLegacy
Application\Legacy reportsCISQ Security Compliance Report.docxLegacy
Application\Legacy reportsCISQ Security Detailed Report.docxLegacy
Application\Legacy reportsCISQ Security Full Detailed Report.xlsxLegacy
Application\Legacy reportsAssessment-sample1.docxLegacy
Application\Legacy reportsAssessment-sample2.docxLegacy
Application\Legacy reportsAssessment-Security1.docxLegacy
Application\Legacy reportsAssessment-Security2.docxLegacy
Application\Legacy reportsExecutive-summary.docxLegacy
Application\Legacy reportsExecutive-summary-sample1.pptxLegacy
Application\Legacy reportsExecutive-summary-sample2.pptxLegacy
Application\Sizing reportsAEP-sample-Template.xlsx Updated (limit the number of rows to 5000 to avoid performances issues)
Application\Sizing reportsFunction-points-sample.xlsx