Differences

This shows you the differences between two versions of the page.

--- technote:report_output_format [2020/11/04 01:56] – created Scott Cunliffe
+++ technote:report_output_format [2026/07/24 02:21] (current) – Scott Cunliffe
@@ Line 1: / Line 1: @@
 ====== Report Output Formats ======
-Output from the Command Line Utilities can be redirected to a file, default format being a text file.  Using Variables the output can be formatted to CSV, Excel, PDF, HTML or XML files.
+Output from the Command Line Utilities can be redirected to a file, the default format being a text file.  Using Variables the output can be formatted to CSV, Excel, PDF, HTML or XML files.
-Along with the file format, output path and headings can be customised, columns can be omitted from the report, output file name customised and portrait or landscape orientation and customised logo for PDF formats.
+Along with the file format, output path and headings can be customized, columns can be omitted from the report, output file name customized and portrait or landscape orientation, and customized logo for PDF formats.
+All the following examples show the code necessary to run a report in a command line window.  The code can also be placed in a batch file which can then be run at any time, either manually or scheduled to run autoamtically.
 ===== Text File =====
+Capturing the output from Command Line Utilities is as simple as redirecting the standard output and providing the file name and directory path you want the file written to.
+==== Example ====
+Using [[cli:TMSS10Inventory|TMSS10Inventory]] as an example Command Line Utility, outputting the standard output to a file named Inventory.txt in the directory.
+<code plain;>
+TMSS10Inventory -S user:-password@server -V "US01.*.*" -M 1 > Inventory_Report.txt
+</code>
 ===== CSV File =====
+To run a report with a CSV output, the variable TMSSREPORTFORMAT needs to be set before running the report utility.
+==== Example ====
+Using [[cli:TMSS10Inventory|TMSS10Inventory]] as an example Command Line Utility, outputting the standard output to a file named Inventory.csv in the directory.
+<code plain;>
+TMSS10Inventory -S user:-password@server -V "US01.*.*" -M 1 > Inventory_Report.csv
+</code>
 ===== Excel File =====
@@ Line 17: / Line 38: @@
 ===== XML File =====
-{{tag> update_doco report variable cli technote}}
+{{tag> update_doco report variable cli_report technote}}