Command-Line Syntax

Provide the complete path and name of the report file to process.

Download Report

Report Commander can download the source report file using HTTP or ftp using the following syntax:

If the server requires authentication, include the user ID and password as part of the URL, as shown above.

If the Web server uses Windows (integrated) authentication, Report Commander will automatically authenticate using the credentials of the user running the program, if credentials are not included as part of the URL.

If database login credentials are required or you need to override the connection to point to a different data source, use the -login option to provide them.

If the report uses more than one database connection, provide the credentials for each, in the same order they occur in the report.

Each "login" parameter consists of one or more of the following sections:

{server:servername}

Specify the new server name or address

{database:dbname}

Specify the new database name

{schema:schemaname}

Specify the new schema name

{userid:userID}

Specify the user ID

{password:password}

Specify the unenecrypted password

{encryptedpassword:password}

Specify an encrypted password (generated using the -encrypt option)

All sections are optional. If the password or encryptedpassword section is used, it must come last. Do not leave a space between sections.

For example:

-login={userid:userid1}{password:password1} -login={userid:userid2}{password:password2}

Override the connection to use a different database on the same server:

-login={database:mynewdb}{userid:userid1}{password:password1} -login={userid:userid2}{password:password2}

If a connection does not require a user ID and password, or you want to use integrated security for the connection, use "-login=", with no credentials. For example:

-login={userid:userid1}{password:password1} -login= -login={userid:userid3}{password:password3}

(The second connection does not require credentials)

If you are using Report Commander from a batch file or other tool and do not want people to be able to see your database login password, you can encrypt the password for use on the command line. Assuming your password is "mypassword", you would first run:

adcrutil -encrypt=mypassword

This would return an encrypted value similar to

5vFHQI+NNBsoaZqzG9eJTA==

You would then use the encryptedpassword option in your batch file:

adcrutil -login={userid:myuserid}{encryptedpassword:5vFHQI+NNBsoaZqzG9eJTA==} ...

Use with the print command to print to a printer other than the default.

For example:

-print -printer="HP Laserjet 2000000"

This value can contain variables and functions that are replaced at runtime.

Export the report to the specified file name. Include the path for the file, or it will be exported to the current working directory.

If you are using the -removefile option to delete the file after it is e-mailed, you do not need to include the path, as the file will be exported to a temporary location.

The output file can be uploaded to remote server using HTTP, FTP, or SFTP. See the Uploading Output topic for more information.

This value can contain variables and functions that are replaced at runtime.

Specify the format to which the report should be exported. Additional formatting options are available for some export formats.

Valid values for format are:

csv

CSV (Comma-Separated Values). More options for CSV exports

html

HTML 4.0. More options for HTML exports

html32

HTML 3.2. Provides backward compatibility with older browsers and e-mail clients that do not support DHTML. More options for HTML exports

msword

Microsoft Word. More options for Word exports

pdf

Adobe Portable Document Format ("Acrobat"). More options for PDF exports

rpt

Crystal Report format. Similar to using the "Save Data with Report" option in the Crystal Reports designer

rtf

Rich Text Format. More options for RTF exports

editablertf

Microsoft Word/RTF - Editable. More options for editable RTF exports

text

Plain text. More options for text exports

xls

Microsoft Excel 97-2003 Spreadsheet. More options for Excel exports

xlsx

Microsoft Excel Spreadsheet (newer XLSX format). More options for Excel exports

xlsrecord

Microsoft Excel Spreadsheet (Data Only). More options for Excel Data-Only exports

xml

XML format. More options for XML exports

Specify the e-mail address (and, optionally, name) from which the message will be sent. If this option is omitted, the default sender specified in the shared e-mail settings will be used. If no default sender is present, Report Commander will issue an error and the e-mail message will not be sent.

This value can contain variables and functions that are replaced at runtime.

Specify the e-mail address(es) to which the message will be sent. Multiple recipients can be specified by using multiple -emrecipient parameters. For example:

[email protected] -emrecipient="Another Person <[email protected]>"

You can prefix a recipient with "TO:", "CC:", or "BCC:" to specify how the recipient should be added to the message. For example:

-emrecipient="TO:[email protected]" -emrecipient="CC:Another Person <[email protected]>" -emrecipient="BCC:Secret Recipient <[email protected]>"

To send the message to members of a distribution list, specify the name of the distribution list prefixed with "@":

-emrecipient="TO:@salesmanagers" -emrecipient="CC:@projectmanagers"

This value can contain variables and functions that are replaced at runtime.

Specify the subject of the e-mail message. If -emsubject is omitted, a default subject will be used.

This value can contain variables and functions that are replaced at runtime.

Specify the text of the e-mail message. If -emtext is omitted, a default message will be used. If HTML tags are detected in the text, the message will be formatted as an HTML message.

To load the message body from a file, use

-emtext="@filename"

where filename is the file that the body should be loaded from at runtime. If the file has extension ".htm" or ".html" the message will be formatted as an HTML message. Otherwise it will be formatted as a plain text message (no check is done for HTML tags in the file).

If you are exporting your report to HTML or plain text format, you can use the export file as the message body by specifying

-emtext=@

(with no file name specified)

Attach additional files to the e-mail message when e-mailing the report output. For example, you may want to attach an HTML page with a standard report key or overview. Attach multiple files by using multiple -attachfile parameters. For example:

-attachfile="c:\files\note1.htm" -attachfile="c:\files\note2.htm"

This value can contain variables and functions that are replaced at runtime.

Causes Report Commander to write all progress and error messages to the specified log file, in addition to writing them to the console.

This value can contain variables and functions that are replaced at runtime.

Follow with any parameters required by the report.

The -parameters option must come after all other options, and be followed by the parameters, in the order they are expected by the report.

Parameters that contain spaces or punctuation must be enclosed in quotation marks.

This value can contain variables and functions that are replaced at runtime.

Multiple Values

For parameters that accept more than one value, use the following syntax:

-parameters "value1,value2,value3"

Note that parameters containing a quotation mark or comma are not supported.

Ranges

For parameters that accept a range of values, use the tilde (~) to separate the beginning and ending values. For example:

-parameters 3.5~26

You may omit the starting and ending value if appropriate:

By default the starting and ending value will be included in the range. To exclude a value, prefix it with an exclamation (!). For example:

-parameters 1~!4

This would include all values in the range from 1 to 4, including 1 but not 4.

Example

Your report expects three parameters: A start date (date), end date (date) and the names of the regions to report on (multi-value string). The parameters would be specified on the command line as:

-parameters "12/1/2003" "12/31/2003" "Region A,Region B, Region C"