| Command line option* | Description |
|---|
| --action=value | A vnccmd:command action, in URI format, to perform, inclusive of that action's arguments |
| --actionLimit=value | Used in conjunction with --action to specify the maximum number of actions that will be executed |
| --bulksize=value | The maximum number of records to output to DB in one call (500 by default) |
| --emailAttach=value | (optional) - True (default): Email output in the specified format as an attachment
- False: Email as embedded HTML
|
| --emailBlank=value | - True: Email blank outputs
- False (default): Email non-blank outputs only
|
| --emailFrom=value | Sender's email address (as specified in Messaging Service Configuration Outgoing Message Locations, e.g., xxxx@gmail.com) to use when emailing report output (optional, to be used with emailTo option) |
| --emailTo=value | A comma-separated list of user names, Distribution List(s), and/or companyNo (for Address Book report distribution) to receive the output by email |
| --env=value | IMOS environment to use (optional) |
| --httpHeader headerName headerValue | HTTP header fields added to outgoing HTTP messages generated by imosmail.exe to support external systems that require additional parameters to accompany the message payload (e.g., a user name and password) |
| --httpRequest URL | Method for sending an HTTP request, supported by imosmail.exe |
| --locale=VALUE | Locale format for the report to export in; the value comes from OS Language Value Codes |
| --multithread | Commands Datashed to run across multiple threads, taking full use of available CPU cores to perform its query faster |
| --outputPath=value | Output location (optional, overrides Report Designer view settings): - If rvOutputType=doc, the value is a full path to the output file.
- Otherwise, the value is an output directory (folder).
|
| --rvFile=value | An exported Report Designer FORM file to run |
| --rvFilter=value | A series of logical filters that can apply to the object specified by rvForm |
| --rvForm=value | An IMOS Dataforms Object to run |
| --rvOutputType=value | - list (default)
- doc (requires using at least the --rvFile and --outputPath options): Exports a report definition with the data you want, including joins, to a hierarchical XML that can be used in stylesheets
- --rvFile must specify a Report Designer FORM file that outputs only one instance of the first Table selected. To do this, use report filters in the report definition or use the --rvFilter option with the Datashed. For example, to export a Voyage object to an XML, the FORM file must be a report that filters all voyages down to a single voyage.
- When the data is exported, a structured XML file is created with the first Table set as the root of the XML file. Fields that are included in the report definition are exported to the XML file. Joined tables are created as child elements of the root and their joined fields are exported as well. The system supports nesting joined tables to any level.
|
| --rvTitle=value | Report Designer view title to run |
| --rvBaseID=value | Value of the viewID from the query retrieved when running: - select viewID, * from reportview where title = '{YOUR_REPORT_TITLE}'
|
| --stream | Reads data from the database in chunks of 5,000 records to prevent out-of-memory exceptions that might occur from loading all the data at once. The report being run must be uniquely sorted using only standard columns, and output must be set to XML or CSV |
| --streamBatchSize number | Used in conjunction with --stream to specify how many records should be loaded per batch |
| --user=value | User name to use for resolving meta-user fields in reports (optional) |
| --webpost URL | Method for sending an HTTP request, supported by imosmail.exe |
| --webprocess URL | Method for sending an HTTP request, supported by imosmail.exe |
| --webquery URL | Method for sending an HTTP request, supported by imosmail.exe |
--bulktimeout=value | Datashed parameter which is relevant when running Reporting DB reports. The value set in this parameter will be the time (in seconds) allocated for time out. |