Using NX Open with report commands

NX Open provides a set of tools to gather data required for a report. You can use NX Open to create programs for use in different templates, solutions, and where names are different, such as groups. You can create programs to extract the required data in a format and layout that meets your company requirements. In addition, as the software continues to develop and store more data, the NX Open programs continue to operate and can be extended to take advantage of the new data for report writing.

You can write an NX Open program in any of the supported development languages, including Python, Visual Basic (VB), C++, C#, and Java. The Default library contains sample commands with associated NX Open programs, which you access through the Report Command Manager.

The report writer has its own set of APIs but you can use the other NX Open APIs as well. For more information, see APIs for Report Writing.

For more information, see the NX Open documentation in the Programming Tools area of the Help.

Default NX Open programs

Use the Report Command Manager to view the sample commands and whether they have associated NX Open programs. The following graphic highlights in green a report command with an associated NX Open program and highlights in red a report command that does not.

In the Report Command Manager:

• The Language column lists the language in which the program is written.

• The Library/File column shows the partial path to an associated script.

• The Function column shows the partial path to a function for C++. Because all commands in the Default library are written in Python, the Function column is blank.

For the Default library, the complete path to a script or function is:

**$UGII_BASE_DIR\simulation\report\commands**

where $UGII_BASE_DIR is the installation location for this software.

For other libraries, the complete path to scripts or functions is the location specified in the associated environment variable. For more information, see Report command libraries.

You can export and import report commands from a user library to another or to a site or vendor library. Exporting a report command includes the NX Open program, as well as its definition in the Report Command Manager. After the command is imported, it is ready to be used to publish reports.

APIs for Report Writing

Use any of the following NX Open APIs to create an NX Open program to associate with a report command.

Output	Purpose	Inputs
Text	Add a string to the report output	None
Image	Add an image group and an image to the group	The image path and name Image caption string
Table	Plain grid style tableOptions to merge cells	Number of columns and rows String to be placed in each cellTable caption string
Report log file	Monitor progress, errors, exits, and more	None

Argument definition validation

The argument definitions in the Report Command Manager check that the arguments in the report template are correct. The software then passes the arguments to the NX Open program to be interpreted as required. For example, for the custom User_Image_NXMP_AxiSym report command, the software receives the arguments as strings and the NX Open program converts them to the required type.

Report Command Manager	Command Name: User_Image_MP_AxiSym
Arguments:
t = double, >=0
rt = integer, >=1 <=100

Word Report Template	<<<User_Image_MP_AxiSym **t**=1001.4 **rt**=10>>>

NX Open Python program	if argv[i] == "t": timeValue = float(argv[i+1]) #Convert string to double.
if argv[i] == "rt": resultType = int(argv[i+1]) #Convert string to double.

Report writing explicit arguments

The report writer provides the following arguments to the NX Open program.

Argument	Use
context	An integer value (solution tag) to which the report is attached.
workdir	Name of the temporary working folder for the current report.Useful for temporary files because the folder is deleted at the end of the report generation process.
xmlfile	Name of the xml file the report writer uses to merge data into the report.

How do I

Create a report command

Get help or find more example commands

Search for report commands

Generate a manual of report command descriptions

Import report commands to a library

Export report commands from a library

Learn more

Report commands

Languages supported for writing NX Open report programs

Report command libraries

Quick links

Command reference

Pre/Post video examples

Bulk Entry Descriptions

Simcenter 3D tutorials

Browse Simcenter 3D help by product area

Using NX Open with report commands, 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 } });