Report command libraries

Report command libraries provide a collection of registered commands to use to create report templates. The libraries consist of a Report Writing binding xml file (ReportCommandLibraryConfiguration.rbx) and automation programs.

The Report Command Manager manages the command libraries. The Report Command Manager only displays libraries that have their location set in the appropriate environment variable. For example, if UGII_USER_DIR is not set, the Report Command Manager does not display the User library node on its tree of libraries.

You can export and import report commands to and from the libraries.

Types of libraries

Four command libraries are available.

The Default library is provided with the software and cannot be changed. You can customize the other libraries, including changing their locations using environment variables. You can import commands into the other libraries, depending on the local folder permission configuration.

The libraries have a fixed sequence in the Report Command Manager, which represents the priorities of the libraries with User first followed by the others: User→Vendor→Site→Default.

Library	Description	Environment variable to set
Default	The Default library contains a selection of tested report commands for your use. You can use them in report templates or use them to develop your own commands. The commands are written in the Python scripting language and start with RW_. Note: To edit a report command in the Default library, you must export them and then import them into another library.	Available by default so no environment variable is needed.The default library binding file is located at:*%UGII_BASE_DIR%\simulation\report\commands**The default programs are located at:**%UGII_BASE_DIR%\simulation\report\commands*
Site	The Site library provides a library accessible to all users.	UGII_SITE_DIR
Vendor	The Vendor library provides a library in which to share commands with vendors so they can generate reports that meet your company's requirements.	UGII_VENDOR_DIR
User	The User library provides a library for a particular user or type of user in your company.	UGII_USER_DIR

Identical commands in libraries

The Report Command Manager allows identical commands to exist concurrently in a library or within different libraries. A command is identical when the command name and input parameters are the same. When publishing a report, the report writer uses the newest command (the later the command appears in the Report Command Manager, the newer the command is).

If you define the same command in different libraries, the latter command is used. For example, if you register the command RW_EXPValue in both the Default and User libraries, the User library version overrides the Default library version, and the report writer uses it to publish 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

Using NX Open with report commands

Languages supported for writing NX Open report programs

Quick links

Command reference

Pre/Post video examples

Bulk Entry Descriptions

Simcenter 3D tutorials

Browse Simcenter 3D help by product area

Report command libraries, 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 } });