Report templates

Video: Create a report template

A report template defines the content, layout, and style of a published report.

The software provides a library of simple report templates, which you or your administrator can modify to define your own. You can modify a report template by changing arguments, such as adding your own group names by which to filter information, or you can create an entirely new template. The figure summarizes the process of creating a template.

Step 1: Copy and rename a template from the template library.	**Step 2:**Edit the template by adding commands as keywords from the command library or creating your own.	**Step 3:**Save the new template in a user or site location.

Keywords

Keywords in a template define the content, layout, and style of the published report. For example, the <<>> keyword requests that a user enter a title for the report, which the user does through the Simulation Navigator when they select to create the report. When the user publishes the report, the title appears in the style and layout shown in the template.

The keywords correspond to commands in the Report Command Manager libraries. The name of the command is the same as the keyword in the report template. The text that is shown in the Simulation Navigator is set in the command definition in the Report Command Manager.

The following table shows several default commands, their arguments, and the corresponding keyword format.

Command name	Arguments	Keyword format
RW_ReportTitle	None	<<>>
RW_MaterialsSummary	None	<<>>
RW_GroupImagesFilter	grp (Group)or (Orientation)	<<>>
RW_ExprValue	expr (Expression)	<<>>

Note:

• Each default keyword contains the string format <<<RW_*>>>.

• Tables are in standard grid style, as shown in the figure, and you may want to format them after publishing the report.

Sequence of information

Report templates generally follow these stages:

Data gathering

Extracting data from this software with no user input. For example:Physical property dataMaterial dataImages of results contours or graphs

Program arguments

Filters for data extraction, for example, by material type for different formatting of the extracted dataImage orientation when viewed in the reportImage size when viewed in the report

Formatting of the gathered data

For example:TextImagesTables

Test and troubleshoot

After you create a template, test it by using it to create and publish a report. Errors are written to a log file in the same location as the published report. Common errors are that a command is not in a library or that an argument value is not appropriate for the current model. For example, if the argument value is the name of a group that is not in the model or a model does not contain groups.

How do I

Create a report template

Quick links

Command reference

Pre/Post video examples

Bulk Entry Descriptions

Simcenter 3D tutorials

Browse Simcenter 3D help by product area

Report templates, Simcenter 3D 2021.1 Series

© 2020 Siemens

window.mainLanguage="en_US"

window.delivId=""

window.projectId=""

MathJax.Hub.Config({ TeX: { extensions: ["autoload-all.js"] }, tex2jax: { displayMath: [ ] }, "SVG": { scale: 125 } });