Creating a MAX Technical Report to Document Configuration Information

Updated Oct 7, 2019

Reported In

Software

  • Measurement and Automation Explorer (MAX)
  • LabVIEW

Issue Details

How can I generate a document with a list of all installed NI software versions on my computer or remote system?

Solution

Create Report Using NI Measurement & Automation Explorer (MAX)

  1. Launch the MAX Report Wizard by selecting File»Create Report:
  1. Choose My System to create a report for the development computer or choose a remotely connected systems to create a report specific for a remote system:
  1. ​ There are three types of HTML reports that you can generate:
    • Simple report: A simple report which consists of just the MAX configuration tree item names and icons.
    • Custom report: A custom report in which you can select the items you want to document and receive a more detailed report for those items.
    • Technical support report: Choose this option if you are working with NI technical support on an issue, and you need to send in your MAX Report to provide more detailed information about your setup, including an installation log of National Instruments software. 
  1. ​(Optional) Click Next and configure the custom options for the custom report or add any additional files you would like to include in the Technical support report.
  2. Click Next to enter a location and file name for your report.
  3. Click Generate.

Programmatically using LabVIEW

  1. ​Launch LabVIEW.
  2. Go to Help»Find Examples
  3. Search Max Report.
  1. Double-click on example Generate Max Report.vi. LabVIEW opens up showing this example file.
  2. On the Front Panel, select the Report Type that you wish to generate.
  3. In the File Path control, put a file name with the extension corresponding to the Report Type. e.g. .zip for Technical Support type. You can click the Open icon to use your operating system's Open dialog.
  1. Run the VI. The report is now being generated.

Additional Information

The MAX Technical Report generation process can also be invoked directly from the command line without opening MAX. You can do this by passing special arguments to the MAX executable.
  1. Open your command prompt and navigate to the folder that contains NIMax.exe. This location depends on where you installed your National Instruments software. The default location is <Program Files (x86)>\National Instruments\MAX\. To change the current file path, use the cd command and then enter the directory you want to move to. An example of this is shown below:
  1. Once you have navigated to this location, enter your desired parameters to the MAX report generation command (nimax /REPORT) to generate your report. The syntax is as follows:
nimax /REPORT:fileName="<absolute path to a file>";reportType="<custom|simple>";silent="<true|false>"
 
 
Parameters include:
  • filename (required) is the filename for the generated report. It must be an absolute path to a file. Valid file formats are .htm, .html, and .xml. In case you provide a non-valid file extension, NI MAX will silently refrain from creating a report. Any existing file will automatically be overwritten.
  • reportType (optional) is simple (no details) or custom (full details). The default value is custom (full detail).
  • silent (optional) is true or false. If set to true, all errors will be silently ignored by NI MAX. No message boxes will be displayed to report errors or a completion status. true is the default value.
Notes:
  • NI MAX will need a minute or two to collect all information for a report. No information is shown during this process. A completion message is shown when silent="false".
  • NI MAX will silently ignore commands with a broken syntax and not create a report in such cases.
  • NI MAX will report destinations that are not writeable only when silent="false".
  • Quotes are necessary around each parameter value.
  • Parameters are case-insensitive.
  • Parameters should be separated by semicolons, with no spaces in between.
  • The creation of remote system reports is currently not supported from the command line. If you want to create a report for a remote system, you need to use the MAX Technical Report Wizard.

The following examples demonstrate correct uses of the command line report generation:
  • nimax /REPORT:fileName="C:\reports\my_file.html"
  • nimax /REPORT:fileName="C:\users\myusername\desktop\my_file.htm"
  • nimax /REPORT:fileName="C:\reports\my_file.xml";reportType="custom"
  • nimax /report:fileName="C:\reports\my_file.htm";Silent="false"
  • nimax /report:fileName="C:\reports\my_file.htm";reportType="simple";Silent="false"

WAS THIS ARTICLE HELPFUL?

Not Helpful