directory\SFQuery.exe

In place of directory, enter the directory where Stonefield Query is installed. If there is a space in the directory, put quotes around this command. For example:

"C:\Program Files\Stonefield Query\SFQuery.exe"

If the Stonefield Query configuration files aren't located in the same directory as SFQUERY.EXE and Stonefield Query hasn't been run before on this computer, add "ini=directory" to the command line. In place of directory, enter the directory where the configuration files are located. Again, if there are any spaces in the directory, surround the entire parameter with quotes.

To automatically log into Stonefield Query, add "user=username" and "password=userpassword" to the command line. In place of username and userpassword, enter the user name and password. Here's an example (although this example is displayed on several lines for formatting purposes, enter everything on one line):

"C:\Program Files\Stonefield Query\SFQuery.exe"
  user=etaylor password=diamond

If you want Stonefield Query to automatically print a particular report, add "report=reportname" to the command line. In place of reportname, enter the name of the report. Put quotes around the entire parameter (for example, "report=My Activity Report") if there are any spaces in the report name. If you want to run more than one report, specify "report1=reportname1", "report2=reportname2", and so forth.

Stonefield Query can also accept several other parameters that tell it how to behave:

• PRINT (or not specified): prints the report to the printer (like clicking the Print button in the Reports Explorer). This affects all reports specified by "report=" parameters.

• PREVIEW: previews the report on the screen (like clicking the Preview button in the Reports Explorer). This affects all reports specified by "report=" parameters.

• FILENAME=filename.ext: outputs the report to the specified file. In place of filename.ext, specify the desired filename and extension. The file type is determined by the extension: "XLS" for an Excel file, "CSV" for comma-delimited, "TXT" for a text file, "DOC" for a Word document, "PDF" for a PDF file, "DBF" for a Visual FoxPro file, "RTF" for an RTF file, or "HTM" for a Web page. Put quotes around the entire parameter (for example, "filename=C:\My Documents\My Spreadsheet.xls") if there are any spaces in the filename. If you want to run more than one report, specify "filename1=filename1.ext" as the file name for the first report, "filename2=filename2.ext" as the name for the second, and so forth.

• TYPE=type: since Stonefield Query can output different types of files for some file types (for example, both table and full format for Word), specify the type of file you want for these types: either "full" for full format or "data" for data-only (in the case of Excel) or table format (for Word and HTML). If you want to run more than one report, specify "type1=type1" as the type for the first report, "type2=type2" as the type for the second, and so forth.

• TEMPLATE=template name: uses the specified template for the report. In place of template name, specify the desired template name.

• MAILTO=email address: sends an email to the specified email address with the report as a PDF attachment. You can specify the subject and body of the email by adding SUBJECT=subject text and BODY=body text to the command line. Put quotes around each entire parameter if there are any spaces in the subject or body. This affects all reports specified by "report=" parameters.

• NOSHOW: if the report is output to a file, use this parameter to indicate the file is not displayed after it's created (like turning off the Display file after creation option in the Output page of the Reports Explorer). This affects all reports specified by "report=" parameters.

• VALUE=value: this specifies a list of values for any "ask at runtime" filter conditions. In place of value, specify the desired value. For dates, use the format YYYY-MM-DD. For logical or Boolean fields, use "T", "True", "Y", or "Yes" for True (anything else is considered to be False). For the "is between" or "is one of" operators, separate the values with commas (for example, "2002-01-01,2002-12-31" for a "Date is between 01/01/2002 and 12/31/2002" condition). There can be several of these parameters, each for a different condition (the first one is for the first "ask at runtime" condition, the second is for the second condition, and so forth); for example, value=Germany value=2002-01-01,2002-12-31 specifies the values for two conditions. If you want to run more than one report, specify "value1=value1" for each of the values for the first report, "value2=value2" for the values for the second, and so forth. Omit the value (that is, use "VALUE=" without specifying a value) to ignore the condition.

• ACTION=name: this tells Stonefield Query to perform some maintenance at startup. In place of name, specify "reindex" to recreate the indexes for its data files, "repair" to repair and reindex its data files, "setup" to display the Setup dialog normally only displayed the first time you run Stonefield Query, or "fixsecurity" to fix any problems that may have arisen with report security. Note: you can also specify a startup action by adding Action=name (where "name" is the name of the action) to an Other section in SFQuery.INI.

• PRINTER=name: tells Stonefield Query to print the report to a specific printer. In place of name, specify the name of the printer to use as it appears in the Windows Printers and Faxes dialog.

• EXIT: closes Stonefield Query after printing the report. This is useful if you only want Stonefield Query to output the specified report and not display its normal user interface. This affects all reports specified by "report=" parameters. When it terminates, Stonefield Query sets an exit code so you can determine the outcome of the report request. If you call Stonefield Query from a batch file, you can check the ERRORLEVEL system variable to determine the exit code. From other applications, use the Windows API GetExitCodeProcess function; search http://msdn.microsoft.com for information on this function. The following codes are used:

  Decimal Value	Hex Value	Meaning
  0	0x0	Report ran successfully.
  -1	0xFFFFFFFF	Stonefield Query terminated with an unexpected error.
  -2	0xFFFFFFFE	There is no default printer driver.
  -10	0xFFFFFFF6	The request is to output to file but no file name was specified.
  -11	0xFFFFFFF5	The report name specified does not exist.
  -12	0xFFFFFFF4	An error occurred running the report.
  -13	0xFFFFFFF3	The report has ask-at-runtime conditions and not all values were provided.
  -14	0xFFFFFFF2	Login failed: the user name and password weren't specified or were incorrect or that user is already logged in.
  -15	0xFFFFFFF1	The demo or unactivated version has expired.
  -16	0xFFFFFFF0	The location of the configuration files could not be determined.
  -17	0xFFFFFFEF	A component is missing. Please reinstall Stonefield Query.
  -18	0xFFFFFFEE	The reports table cannot be opened.
  -19	0xFFFFFFED	The security tables cannot be opened.
  -20	0xFFFFFFEC	A script failed.
  -21	0xFFFFFFEB	There are no data sources available to query on.
  -22	0xFFFFFFEA	The location of the reports table has not been specified.
  -23	0xFFFFFFE9	Invalid license file.
  -24	0xFFFFFFE8	Setting up of the data and report engines failed.
  -25	0xFFFFFFE7	The printer name specified in the PRINTER= parameter does not exist.
  -26	0xFFFFFFE6	An invalid output type was specified.
  -27	0xFFFFFFE5	The resource file (SQResource.DBF) cannot be located.

If the command line becomes too long (Stonefield Query only accepts 15 parameters; more than that cause an error) or you'd rather put the parameters into a file for more flexibility (it's probably easier to change the contents of a file than to change how Stonefield Query is called), specify the name of the file containing the parameters by adding "parameters=filename", where filename is the name of the file containing the parameters. The file must contain the same format of parameters passed on the command line, with each parameter on a separate line, except you don't need quotes even if there are spaces in the names. Here's an example of such a file that outputs the Activity Report for March 2001 to an Excel document named C:\Temp\My Spreadsheet.xls and the History Report to a PDF file named C:\Temp\MyPDF.pdf, and then exits Stonefield Query:

report1=Activity Report
filename1=C:\Temp\My Spreadsheet.xls
value1=2001-03-01,2001-03-31
report2=History Report
filename2=C:\Temp\MyPDF.pdf
user=etaylor
password=diamond

Here are some examples of these parameters (although these examples are displayed on several lines for formatting purposes, enter everything on one line):

"C:\Program Files\Stonefield Query\SFQuery.exe"
   "report=Activity Report" user=etaylor password=diamond

Prints the Activity Report to the printer.

"C:\Program Files\Stonefield Query\SFQuery.exe"
  "report=Activity Report" preview
  user=etaylor password=diamond

Displays the Activity Report in the preview window.

"C:\Program Files\Stonefield Query\SFQuery.exe"
  "report=Activity Report" preview
  value=2001-03-01,2001-03-31
  user=etaylor password=diamond

Displays the Activity Report in the preview window for records between March 31, 2001 and March 31, 2001 (assuming an ask at runtime condition on the date range).

"C:\Program Files\Stonefield Query\SFQuery.exe"
  "report=Activity Report" filename=C:\Temp\MySpreadsheet.xls
  user=etaylor password=diamond

Outputs the Activity Report to an Excel document named C:\Temp\MySpreadsheet.xls and brings up Excel once the document is ready.

"C:\Program Files\Stonefield Query\SFQuery.exe"
  "report=Activity Report" filename=C:\Temp\MySpreadsheet.xls
  noshow user=etaylor password=diamond

Outputs the Activity Report to an Excel document named C:\Temp\MySpreadsheet.xls but doesn't bring up Excel.

"C:\Program Files\Stonefield Query\SFQuery.exe"
  "report=Activity Report" preview exit
  user=etaylor password=diamond

Displays the Activity Report in the preview window and exits Stonefield Query once the preview window is closed.

"C:\Program Files\Stonefield Query\SFQuery.exe"
  "report=Activity Report" "filename=C:\Temp\My Spreadsheet.xls"
  exit user=etaylor password=diamond

Outputs the Activity Report to an Excel document named C:\Temp\My Spreadsheet.xls, exits Stonefield Query, and opens the document in Excel.

"C:\Program Files\Stonefield Query\SFQuery.exe"
  "report=Activity Report" mailto=myboss@mycompany.com
  "subject=This Week's Activity Report"
  "body=Here's the activity report for this week."
  exit user=etaylor password=diamond

Emails the Activity Report as a PDF file attached to a message sent to myboss@mycompany.com.