Page tree
Skip to end of metadata
Go to start of metadata

On this page:

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"

Components list

Text componentsText components available for Report Generator 1.21
Graph componentsGraph components for Report Generator 1.21
Table componentsTable components for Report Generator 1.21
Generic components

Generic components in Report Generator 1.21

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-CN 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.

LocationReport NameCAST-RestApi minimum version

Quality Standard Mapping extension minimum version

or index extension

Comment
Portfolio\Portfolio component library1- Portfolio-Powerpoint-components-library.pptx1.8.0N/A
Portfolio\Portfolio component library2- Porftolio-Word-components-library.docx1.8.0N/A
Portfolio\Portfolio component libraryPortfolio Generic Graph Definition.docx1.10.020181030
Portfolio\Portfolio component libraryPortfolio Generic Table Definition.pptx1.10.020181030
Application\Component library1- Powerpoint-components-library.pptx1.12.020190909Updated
Application\Component library2- Word-components-library.docx1.12.020190909Updated
Application\Component library3- Excel-components-library.xlsx1.12.020190909Updated
Application\Component libraryGeneric Graph Definition.docx1.10.020181030
Application\Component libraryGeneric Graph Definition.pptx1.10.020181030
Application\Component libraryGeneric Table Definition.docx1.10.020181030
Application\Component libraryGeneric Table Definition.pptx1.10.020181030
Application\Compliance reportsC-CPP Standards Compliance Report.docx1.12.020200203
Application\Compliance reportsC-CPP StandardDetailed Report.docx1.12.020200203
Application\Compliance reportsC-CPP StandardFull Detailed Report.xlsx1.12.020200203
Application\Compliance reportsCISQ Compliance Report.docx1.12.020190916 or CISQ-index 20200518
Application\Compliance reportsCISQ Detailed Report.docx1.12.020190916 or CISQ-index 20200518
Application\Compliance reportsCISQ Full Detailed Report.xlsx1.12.020190916 or CISQ-index 20200518
Application\Compliance reportsCISQ Security Compliance Report.docx1.12.020190916 or CISQ-index 20200518
Application\Compliance reportsCISQ Security Detailed Report.docx1.12.020190916 or CISQ-index 20200518
Application\Compliance reportsCISQ Security Full Detailed Report.xlsx1.12.020190916 or CISQ-index 20200518
Application\Compliance reportsCWE (2011) Top 25 Compliance Report.docx1.12.020190916
Application\Compliance reportsCWE (2011) Top 25 Detailed Report.docx1.12.020190916
Application\Compliance reportsCWE (2011) Top 25 Full Detailed Report.xlsx1.12.020190916
Application\Compliance reportsCWE (2019) Top 25 Compliance Report.docx1.12.020190916
Application\Compliance reportsCWE (2019) Top 25 Detailed Report.docx1.12.020190916
Application\Compliance reportsCWE (2019) Top 25 Full Detailed Report.xlsx1.12.020190916
Application\Compliance reportsCWE (2020) Top 25 Compliance Report.docx1.12.0

20200929


Application\Compliance reportsCWE (2020) Top 25 Detailed Report.docx1.12.0

20200929


Application\Compliance reportsCWE (2020) Top 25 Full Detailed Report.xlsx1.12.0

20200929


Application\Compliance reportsCWE Compliance Report.docx1.12.020190916
Application\Compliance reportsCWE Detailed Report.docx1.12.020190916
Application\Compliance reportsCWE Full Detailed Report.xlsx1.12.020190916
Application\Compliance reportsISO-5055 Compliance Report.docx1.25.020210412.0.0-funcrel or ISO-5055 Index
Application\Compliance reportsISO-5055 Detailed Report.docx1.25.020210412.0.0-funcrel or ISO-5055 Index
Application\Compliance reportsISO-5055 Full Detailed Report.xlsx1.25.020210412.0.0-funcrel or ISO-5055 Index
Application\Compliance reportsMIPS Reduction Compliance Report.docx1.12.0MIPS Reduction Index 20200519
Application\Compliance reportsMIPS Reduction  Detailed Report.docx1.12.0MIPS Reduction Index 20200519
Application\Compliance reportsMIPS Reduction  Full Detailed Report.xlsx1.12.0MIPS Reduction Index 20200519
Application\Compliance reportsNIST-SP800-53R4 Compliance Report.docx1.12.020190909
Application\Compliance reportsNIST-SP800-53R4 Detailed Report.docx1.12.020190909
Application\Compliance reportsNIST-SP800-53R4 Full Detailed Report.xlsx1.12.020190909
Application\Compliance reportsOMG-ASCQM Compliance Report.docx1.12.020190916 or OMG-ASCQM index 20200518
Application\Compliance reportsOMG-ASCQM Detailed Report.docx1.12.020190916 or OMG-ASCQM index 20200518
Application\Compliance reportsOMG-ASCQM Full Detailed Report.xlsx1.12.020190916 or OMG-ASCQM index 20200518
Application\Compliance reportsOMG-ASCQM Security Compliance Report.docx1.12.020190916 or OMG-ASCQM index 20200518
Application\Compliance reportsOMG-ASCQM Security Detailed Report.docx1.12.020190916 or OMG-ASCQM index 20200518
Application\Compliance reportsOMG-ASCQM Security Full Detailed Report.xlsx1.12.020190916 or OMG-ASCQM index 20200518
Application\Compliance reportsOWASP-2013 Compliance Report.docx1.12.020190916 or OWASP index 20200518
Application\Compliance reportsOWASP-2013 Detailed Report.docx1.12.020190916 or OWASP index 20200518
Application\Compliance reportsOWASP-2013 Full Detailed Report.xlsx1.12.020190916 or OWASP index 20200518
Application\Compliance reportsOWASP-2017 Compliance Report.docx1.12.020190916 or OWASP index 20200518
Application\Compliance reportsOWASP-2017 Detailed Report.docx1.12.020190916 or OWASP index 20200518
Application\Compliance reportsOWASP-2017 Full Detailed Report.xlsx1.12.020190916 or OWASP index 20200518
Application\Compliance reportsOWASP-API-2019 Compliance Report.docx1.12.020200302
Application\Compliance reportsOWASP-API-2019 Detailed Report.docx1.12.020200302
Application\Compliance reportsOWASP-API-2019 Full Detailed Report.xlsx1.12.020200302
Application\Compliance reportsOWASP-Mobile-2016 Compliance Report.docx1.12.020190916
Application\Compliance reportsOWASP-Mobile-2016 Detailed Report.docx1.12.020190916
Application\Compliance reportsOWASP-Mobile-2016 Full Detailed Report.xlsx1.12.020190916
Application\Compliance reportsPCI-DSS-V3.1 ComplianceReport.docx1.12.020190916
Application\Compliance reportsPCI-DSS-V3.1 Detailed Report.docx1.12.020190916
Application\Compliance reportsPCI-DSS-V3.1 Full Detailed Report.xlsx1.12.020190916
Application\Compliance reportsPCI-DSS-V3.2.1 ComplianceReport.docx1.12.020200302
Application\Compliance reportsPCI-DSS-V3.2.1 Detailed Report.docx1.12.020200302
Application\Compliance reportsPCI-DSS-V3.2.1 Full Detailed Report.xlsx1.12.020200302
Application\Compliance reportsSTIG V4R8 Compliance Report.docx1.12.020190916
Application\Compliance reportsSTIG V4R8 Detailed Report.docx1.12.020190916
Application\Compliance reportsSTIG V4R8 Full Detailed Report.xlsx1.12.020190916
Application\Compliance reportsSTIG V5 Compliance Report.docx1.26.120210517.0.0-funcrelNew
Application\Compliance reportsSTIG V5 Detailed Report.docx1.26.120210517.0.0-funcrelNew
Application\Compliance reportsSTIG V5 Full Detailed Report.xlsx1.26.120210517.0.0-funcrelNew
Application\Legacy reportsAssessment-sample1.docx1.8.0N/A
Application\Legacy reportsAssessment-sample2.docx1.8.0N/A
Application\Legacy reportsAssessment-Security1.docx1.8.0N/A
Application\Legacy reportsAssessment-Security2.docx1.8.0N/A
Application\Legacy reportsExecutive-summary.docx1.8.0N/A
Application\Legacy reportsExecutive-summary-sample1.pptx1.8.0N/A
Application\Legacy reportsExecutive-summary-sample2.pptx1.8.0N/A
Application\Sizing reportsAEP-sample-Template.xlsx1.9.0N/AUpdated
Application\Sizing reportsFunction-points-sample.xlsx1.8.0N/A


  • No labels