WinSPC Knowledgebase Home | Glossary | Favorites | Contact | Login WinSPC Knowledgebase Home | Glossary | Favorites | Contact | Login
Search the WinSPC Knowledgebase Browse by Category
Can I generate a WinSPC report using command line options?
Article Details

Last Updated
3rd of April, 2013

Applies to
WinSPC 8.0, WinSPC 8.1, WinSPC 8.2, WinSPC 8.3

Yes, WinSPC 8.0, and above, supports the ability to run a report book and generate either a pdf or html output.  Using the command line options, you could setup Windows Scheduler to automatically run a report book at a specified time or time interval (for example, every day at 8:00 am).

There are five new command line options available regarding report books:
  • /rb - This option allows you to specify the name of the report book that should be executed.  If the name of the report book contains spaces, you will need to enclose the name in double quotes.  For example:
    WinSPC.exe /rb MyReportBook
    WinSPC.exe /rb "My Report Book"
  • /rp - This option allows you to specify a parameter file that will provide the report book with the values for any prompted parameters or options (for example, the report book might be configured to prompt the user for a date range to use in the report).  The absence of this command tells WinSPC to prompt the end user for any needed parameters.  There are three forms for this option:
    • /rp ParameterFileNameWithNoSpaces.ini - This form is used to tell WinSPC to not prompt for any parameters and allows you to specify a parameter file (or full path to the parameter file) that does not contain any spaces.  If the full path is not specified, the file is assumed to be located in the WinSPC installation folder on the client (by default, "C:\Program Files\DQS\WinSPC\").
    • /rp "Parameter File Name With Spaces.ini" - This form is used to tell WinSPC to not prompt for any parameters and allows you to specify a parameter file (or full path to the parameter file) that does contain spaces.  If the full path is not specified, the file is assumed to be located in the WinSPC installation folder on the client (by default, "C:\Program Files\DQS\WinSPC\").
    • /rp "" - This form is used to tell WinSPC to not prompt for any parameters and use all configured default values for any of the parameters.
  • Values in the file that match a needed parameter in both name and type will be used for generation of this report.  Extra values will be ignored.  The format of each type of parameter must match that which the /rg option dumps.
  • /rg - This option instructs WinSPC to generate a prototype parameter ini file (whose name is specified using the /rp option) for the report book specified by the /rb option.  No report output will be generated when this option is used.  This option must be accompanied by both the /rb and /rp options, and no action will be taken if one or the other is missing.  This ini file then can be used to set the report parameters with the /rp option.  Example:
    WinSPC.exe /rb MyReportBook /rp MyParamFile.ini /rg
    will create the following file (assuming default WinSPC installation directory) and will NOT produce any output:
    "C:\Program Files\DQS\WinSPC\MyParamFile.ini"

  • /rf - This option controls the format of the report output generated by the report book.  There are two forms of this option: 
    • /rfp - If this option is specified, then PDF output will be generated (this is the default if no /rf option is specified).  The name of the PDF file will be the same as the name of the report book and the PDF will be created in the "\Reports" folder in the WinSPC installation folder on the client (by default, "C:\Program Files\DQS\WinSPC\").  For example, if you run the following command line:
      WinSPC.exe /rb MyReportBook /rfp
      The following PDF would be created as the report output:
      "C:\Program Files\DQS\WinSPC\Reports\MyReportBook.pdf"

    • /rfh -If this option is specified, then HTML output will be generated.  The report book will generate the HTML output into a sub-folder of the "\Reports\" directory, named for the report book.  For example, if you run the following command line:
      WinSPC.exe /rb MyReportBook /rfh
      The following directory will be created with the required HTML files to view the report output as a webpage:
      "C:\Program Files\DQS\WinSPC\Reports\MyReportBook\"

  • /rd - This option instructs WinSPC to append the current date/time to the name of the generated report book output.  This allows each report that is produced to be created with a unique name (so it will not overwrite previous reports).  This option will append the date/time in the format of "yyyymmddhhnnss" to the name of the PDF (if the /rfp option is selected) or the folder (if the /rfh option is selected).  For the date/time format:
    yyyy is the four digit year
    mm is the two digit month (with leading zero)
    dd is the two digit day (with leading zero)
    hh is the two digit hour (24 hour format with leading zero)
    nn is the two digit minute (with leading zero)
    ss is the two digit second (with leading zero)
    For example, if you run the following command line:
    WinSPC.exe /rb MyReportBook /rfp /rd
    The following PDF would be created:
    "C:\Program Files\DQS\WinSPC\Reports\MyReportBook 20100217092135.pdf"
Attachments
No attachments were found.
Related Articles
Visitor Comments
No visitor comments posted. Post a comment
Post Comment for "Can I generate a WinSPC report using command line options?"
To post a comment for this article, simply complete the form below. Fields marked with an asterisk are required.
   Your Name:
   Email Address:
* Your Comment:
* Enter the code below:
 

All Content 2012 DataNet Quality Systems. All Rights Reserved.