~~CLOSETOC~~
{{TOC:wide}}
\\

{{ :wiki:sns:snspro:a10.png?300|}}

====== Standard Report ======

A web-ready report of the analysis results may be generated using the **[Report]** button on the View tab:

Scan&Solve Pro will prompt for a destination, generate the report, and open your web browser to view the output.

===== Customizing Report =====

Scan&Solve pro uses template files to construct the web-ready reports when the **[Report]** button is clicked in the View tab. These template files, located in the installation directory, are read by Scan&Solve Pro and the output files are generated based on the contents of the templates. The templates use a simple format that may be easily modified to suit a particular end user application. The only tool required is Microsoft’s Notepad or a similar text editor.

==== Template File Format ====

 The report template file is called **AdvancedReportTemplate.html**. The content of this file looks something like the following (Color and Descriptions added):

{{:wiki:sns:snspro:sns57.png?400|}}

The Report Section, where modifications may be made, contains a mixture of HTML code and Scan&Solve keywords.

The standard HTML code is demarcated by <format_code>text</format_code> where the format_code controls how the text between the demarcations will be formatted in the output report. HTML code is ignored by Scan&Solve and passed to the output unchanged. Thus, the HTML formatting and content can be changed to suit a particular application, including additional text or images. More information on HTML formatting may be found on the web.

The Scan&Solve output is generated by the lines containing a ##KEYWORD followed, in most cases, by a series of parameters. The keywords, their parameters, and their results in the output are as follows:

^Keyword^Parameters|
|//##SCREENSHOT//|With no trailing parameters includes in the report an image from the active Rhino viewport.|
|:::             |//BCS// includes an image of the geometry plus the applied boundary conditions.|
|:::             |SOLUTION includes an image of analysis results as specified by one of the following component tags:| 
|:::             |~ //DSPX// --x component of the computed displacement field|
|:::             |~ //DSPY// --y component|
|:::             |~ //DSPZ// --z component|
|:::             |~ //DSPT// --total displacement|
|:::             |~ //VONM// --Von Mises stress|
|:::             |~ //SIG1// --maximum principal stress|
|:::             |~ //SIG2// --middle principal stress|
|:::             |~ //SIG3// --minimum principal stress|
|:::             |~ //EPS1// --maximum principal strain|
|:::             |~ //EPS2// --middle principal strain|
|:::             |~ //EPS3// --minimum principal strain|
|:::             |~ //DGRL// --material’s default danger level|
|:::             |~ //SED// --strain energy density|
|:::             |~ //PTC// --principal tension/compression|
|//##PROPERTYTABLE//|//GEOMETRY// includes a table of basic information about the geometry.|
|:::                |//MATERIAL// includes a table of the properties of the material currently in use|
|:::                |//LOADS// includes a summary table of the applied loads|
|:::                |//RESTRAINTS// includes a summary table of the applied restraints|
|:::                |//ANALYSISSETTINGS// includes a table of the current analysis settings|
|:::                |//EXTREMA// includes the maximum and minimum values of the analysis results as specified by one of the following component tags:|
|:::                |~ //DSPX// --x component of the computed displacement field|
|:::                |~ //DSPY// --y component DSPZ --z component DSPT --total displacement|
|:::                |~ //VONM// --Von Mises stress|
|:::                |~ //SIG1// --maximum principal stress|
|:::                |~ //SIG2// --middle principal stress|
|:::                |~ //SIG3// --minimum principal stress|
|:::                |~ //EPS1// --maximum principal strain|
|:::                |~ //EPS2// --middle principal strain|
|:::                |~ //EPS3// --minimum principal strain|
|:::                |~ //DGRL// --material’s default danger level|
|:::                |~ //SED// --strain energy density|
|:::                |~ //PTC// --principal tension/compression|
|//##EXTREMATABLE//|Includes the maximum and minimum values of the analysis results as specified by one or more of the following component tags:|
|:::               |~ //DSPX// --x component of the computed displacement field|
|:::               |~ //DSPY// --y component|
|:::               |~ //DSPZ// --z component|
|:::               |~ //DSPT// --total displacement|
|:::               |~ //VONM// --Von Mises stress|
|:::               |~ //SIG1// --maximum principal stress|
|:::               |~ //SIG2// --middle principal stress|
|:::               |~ //SIG3// --minimum principal stress|
|:::               |~ //EPS1// --maximum principal strain|
|:::               |~ //EPS2// --middle principal strain|
|:::               |~ //EPS3// --minimum principal strain|
|:::               |~ //DGRL// --material’s default danger level|
|:::               |~ //SED// --strain energy density|
|:::               |~ //PTC// --principal tension/compression|
|//##DATETIME//|//DATE// includes the current date in the report, may be followed by //TIME//|
|:::           |//TIME// includes the current time in the report, may be followed by //DATE//|

==== Editing the Templates ====

Before editing a report template, make a backup copy in case of errors or problems. Edit the desired template as follows:

  - Start Notepad and choose File>Open...
  - In the File Open dialog, browse to the installation directory and locate the file entitled AdvancedReportTemplate.html. On Windows, the default location will be C:\Program Files\Scan&Solve Pro\AdvancedReportTemplate.html.
  - Open the file.
  - Decide the type of information and its desired location in the report:
    - To add an image showing the geometry alone, add the following to the template file: //##SCREENSHOT//
    - To add an image of the boundary conditions, add the following to the template file: //##SCREENSHOT BCS//
    - To add an image showing a component of the solution displayed on the geometry, refer to the table of keywords above for valid entries for component_tag and add the following line to the template file: //##SCREENSHOT SOLUTION component_tag//
    - To add a table of geometric properties, add the following line to the template file: //##PROPERTYTABLE GEOMETRY//
    - To add a table of material properties, add the following line to the template file: //##PROPERTYTABLE MATERIAL//
    - To add a table of applied loads, add the following line to the template file: //##PROPERTYTABLE LOADS//
    - To add a table of restraints, add the following line to the template file: //##PROPERTYTABLE RESTRAINTS//
    - To add a table of analysis settings, add the following line to the template file: //##PROPERTYTABLE ANALYSISSETTINGS//
    - To add a table showing the extrema of a solution component, refer to the table of keywords above for valid entries for component_tag and add the following line to the template file: //##PROPERTYTABLE EXTREMA component_tag//
    - To add a table summarizing solution extrema, refer to the table of keywords above for valid entries for component_tag and add the following line to the template file: //##PROPERTYTABLE EXTREMA component_tag1 component_tag2 ... component_tag3//
  - Headings and descriptions may be intermixed with the Scan&Solve codes to add comments and headings as desired in the final report.
  - When finished, save the template file in the installation directory.

==== Examples ====

These two examples depict the output arising from sequences of template code. Refer to the previous section for more details on the specific keywords and their parameters.

=== Detail 1 ===

{{:wiki:sns:snspro:sns58.png?600|}}

Template code on the left gives rise to the output on the right. HTML code is output directly to the report file unchanged. Scan&Solve code is interpreted by the Scan&Solve plugin to produce the output shown on the right. This example introduces the use of the //##SCREENSHOT// keyword and the generation of a table using the //##PROPERTYTABLE// keyword.

=== Detail 2 ===

{{:wiki:sns:snspro:sns59.png?600|}}

Template code on the left gives rise to the output on the right. HTML code is output directly to the report file unchanged. Scan&Solve code is interpreted by the Scan&Solve plugin to produce the output shown on the right. This example shows an expanded use of the //##SCREENSHOT// keyword to display a solution value. The //##PROPERTYTABLE// keyword is used to generate a summary of a solution component using the //EXTREMA// parameter and a solution component tag, //TDSP//, for total displacement.

=====Related Video=====
<WRAP half column>
To learn more on how to generate reports, watch Intact Solutions' video "Getting Started with Scan&Solve Pro Part 2: Analyzing Results" from [[https://youtu.be/I9ZMjGpNO9g?t=324|5:24]].

{{youtube>I9ZMjGpNO9g?large}}
</WRAP>