Command-line wizard

The built-in command-line wizard helps you generate command-line syntax based on the options you select. You can save the generated command to a .bat file and use it to schedule or automate report generation tasks.

Open the command-line wizard

To open the command-line wizard, on any page of the Data Report Wizard, select Save Command Line in the lower-left corner.

Open the command-line wizard from the Data Report wizard

Command-line wizard options

The table provides options available in the command-line wizard.

Note

To include an option, select the checkbox for the option. To exclude an option, clear the checkbox.

Option Description
Report File Specifies the full path and file name of the report template (.rdb). Click the ellipsis (…) to browse for the file.
Note: You can use the Data Report Wizard to create the report template. For more information, see Create a report template.
Usage: /reportfile:<file_path>
Connection Specifies the connection string. To generate the connection string, click the ellipsis (…) and select an existing database connection or create a new one. The option is automatically filled with the connection string.
Usage: /connection:<connection_string>
Password Specifies the server password. This value overrides the password in the connection string.
Usage: /password:<pw>
Report Parameters Specifies values for parameters declared in a query script.
Usage: /parameters <param_name1>:<param_value1> <param_name2>:<param_value2> <param_name3>:<param_value3>
Format Specifies the output format of the generated report.
Available options:
  • PDF – A PDF file.
  • HTML – An HTML file.
  • MHT – An MHT (MIME HTML) file.
  • RTF – An RTF (Rich Text Format) file.
  • TEXT – A plain text file.
  • CSV – A CSV (Comma-Separated Values) file.
  • EXCEL – A Microsoft Excel 97-2003 workbook (.xls).
  • EXCEL2007 – A Microsoft Excel workbook (.xlsx) in Office Open XML format.
  • BMP – A BMP (Bitmap) file.
  • GIF – A GIF file.
  • JPEG – A JPEG file.
  • PNG – A PNG file.
  • TIFF – A TIFF (Tagged Image File Format) file.
  • WMF – A WMF (Windows Metafile) file.
  • EMF – An EMF (Enhanced Metafile) file.
If no format is specified, the report format is determined by the file extension.
Usage: /format:<PDF|HTML|MHT|RTF|TEXT|CSV|EXCEL|EXCEL2007|BMP|EMF|GIF|JPEG|PNG|TIFF|WMF>
Type of report result Specifies where the generated report should be delivered. Available options:
  • Directory – Saves the report to a local folder.
  • Email – Sends the report via email.
  • FTP – Uploads the report to an FTP server.
Selecting an option displays additional fields specific to that delivery method.
The path to the generated report Specifies the path to the folder where the generated report is saved. The option is available when Type of report result is set to Directory. Click the ellipsis (…) to browse for the folder.
Usage: /result folder:<path>
Address Specifies the email address for sending the report. The option is available when Type of report result is set to Email.
Usage: /result email:<email_address>
The path to the FTP folder Specifies the path to the FTP folder where the generated report is saved. The option is available when Type of report result is set to FTP.
Usage: /result folder:<path> ftplogin:<username> ftppassword:<password>
Login Specifies the username for FTP authentication. The option is available when Type of report result is set to FTP.
Usage: /result folder:<path> ftplogin:<username> ftppassword:<password>
Password (FTP) Specifies the password for FTP authentication. The option is available when Type of report result is set to FTP.
Usage: /result folder:<path> ftplogin:<username> ftppassword:<password>
Echo OFF Wraps all text in the .bat file within the @Echo OFF ... Echo ON block, preventing commands from being displayed in the command window.
Keep opened Adds the pause command at the end of the .bat file to keep the command window open after execution.
PowerShell Adds the & symbol at the beginning of the .bat file to ensure PowerShell compatibility.

The text box displays the generated script with the specified options.

Command line execution file settings dialog

To save the settings in the .bat file, click Save.

To close the dialog, click Cancel.

Command-line validation

To verify the settings, click Validate.

If the parameter validation succeeds, the following message appears:

Parameters validation - successful

If the parameter validation fails the tool displays the error, for example:

Parameters validation - failed