Quick Reference Guide
Table of contents
- Initiate the report in the project
- Report Settings
- Figure export settings (Legacy)
- Add content
- Load Details
- Result Details
- Tabular Data
- Selected Result Details or Tabular Data
- Disposition
- Grouped Results
- Worksheet preview
- Html Menu
- Edit Report Draft
- Refresh Model from Draft
- Create Report
- Update Figures in Word
- Active License
Initiate the report in the project
To start create a report click Default Comments to initiate the project with the needed comments and tags used by the app.
Report Settings
Starting in V231.3 the Report Settings object is added where all content and style setting are made for the current report. Settings can be imported from a selected previous app version. The settings can then be saved to update the app default values.
Figure export settings (Legacy)
In previous versions (< V231.3) the Figure export settings are defined in the Mechanical Options window or in the preference file.
Add content
Report content is identified by the tag “Report”.
-
Select objects in the tree and click “Tag Report Objects” to include in the report.
-
Remove the “Report” tag by clicking the “Un-Tag Report Objects”.
-
Find all report objects by clicking the “Filter Report Objects”.
-
Insert and name text comments to add information about an object. There are powerful formatting features including reference to parameters and result identifiers.
It is recommended to add comments as “text place holders” and then use the Edit Report Draft to do the actual typing and spell checking. -
Insert and name the Figures. (Default name is “object name”) The name will be used as figure caption text in the report (and picture file name).
-
Use “New Static Images” to add Images to objects. If selecting “Figures” a static figure of each is created, e.g. to compare difference between an original and modified model or to export an individual image.
-
User Command Objects, UCO, “Commands (APDL)” will be included if tagged.
-
Insert “Figures from file” to add external images to the report.
Load Details
Tagging a load object will create a details summary table in the report after the comments and figures.
Result Details
Tagging a result objects (contour, path and probe) will create a results summary table by default.
The automatic table can be included/excluded for the different types of objects by setting the corresponding property to Yes/No in the Report Settings or the parameter to True/False in the preference file.
Tabular Data
Tagging a result, probe or chart will create a Tabular Data table by default.
The automatic table can be included/excluded for the different types of objects by setting the corresponding property to Yes/No in the Report Settings or the parameter to True/False in the preference file.
Selected Result Details or Tabular Data
If the Result/Probe Details Summary or Tabular Data setting is “No” in the Report Settings to prevent the printout a selected result details or tabular data can still be exported by adding the tag “Report Result Details” or “Report Tabular Data” to the object.
Disposition
The report outline level for the main objects (Model, Geometry, Mesh, Analysis, Solution etc.) can be defined in the Report Layout Settings.
Grouping of objects may be used to define a disposition in the report with subheadings.
If the group is tagged a heading is created, if not tagged the group will just “sort” the objects.
One or many groups may be used to re-order the objects in the report. If the group is not tagged the disposition level is not changed.
Grouped Results
Grouping result objects (contour, path and probe) of the same type and tagging the group object but not the result objects will create a results summary table of result details.
Worksheet preview
Select an object in the model tree and click worksheet preview to display all details including the result summary tables. This feature ignores if the object is tagged with “Report” or not.
Html Menu
Use the Html Report to open a preview of the report in a web browser. There are dedicated “Bolt Report” and “Weld Report” templates for use with the “Bolt Toolkit” or “Weld Toolkit”. The html report can be imported to Microsoft Word using the Create Report from Draft.
Edit Report Draft
Use the Edit Report Draft to open a html report draft in Microsoft Word and do additional editing and formatting. Once Word is saved and closed the Mechanical model tree is updated based on the changes in the html document.
Refresh Model from Draft
Use the Refresh Model from Draft to sync changes from the current html report draft back to Mechanical. This is useful if it has been edited “off-line” in a different editor or with Mechanical being closed.
Create Report
Use the Create Report to export and create the report as a Microsoft Word document using the selected Word template.
Changes done in the Word document (.docx/.doc) are not synced back to Mechanical.
Update Figures in Word
Once the report is exported to Word you may Update Figures in Word if needed.
Active License
The Active License button displays the status of the license. Click to release (check in) the license.