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

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

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.

Requirements

• CAST-RESTAPI >= 2.4.0

• Quality standards mapping extension, CISQ, ISO-5055, OWASP index extensions >= 20211122.0.0-funcrel

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

Templates