ExportConfig
Set options for STK to use when exporting reports.
Syntax
ExportConfig <ApplicationPath> {ExportOption} [<Parameters>]
Related commands
Description
The ExportConfig command enables you to change options that STK uses when exporting a report. The export config options are stored with the application, in your _Default.ap file.
You can set export config options for the application and also for individual Connect connections. When a connection is opened, STK sets its initial export option values. Then, using the ExportConfig Connection command, you can change settings for this connection. These settings are only valid while the connection is open. STK does not save these settings. You can separately set export config options for the application.
When you set export config options for the Connection, STK uses them for reports that are exported using the Report_RM command and the ReportCreate command with the Type Export option. When you set export config options for the application, STK uses them for reports that are exported from the STK GUI.
Use the ExportConfig_R command to return the export options values.
| {ExportOption} | <Parameters> | Description |
|---|---|---|
| SaveToConnect | N/A | This option will use the values currently set for the application and will reset the export config values for the current connection. |
| WriteApDefault | N/A | This option will save the current application export config values to your _Default.ap file. |
| Connection | {OptionValuePairs} | Use the Connection keyword to set export config values only for the current connection. STK will use these values for reports created via the Report_RM or Report Export commands. |
| App | {OptionValuePairs} | Use the App keyword to set the export config values only for the application. STK will use these values for reports exported from the STK GUI. |
| All | {OptionValuePairs} | Use the All keyword to set values for both the application and the current Connection. |
The following table describes the {OptionValuePairs} you can use to set the export options. You can include one or more of these options on a command line.
| {Option} | <Value> | Description |
|---|---|---|
| Delimiter | {Comma | SemiColon | Tab | Space | TwoSpace | "<UserDefinedValue>"} | Set the value to be used between fields in an exported report. The "<UserDefinedValue>" can be any sequence of characters. |
| Quotes | {Char | All | None} | Define how quotes are used in an exported report. The Char keyword specifies that quotes will be included around character data only. The All keyword specifies that quotes will be included around all data. The None keyword specifies that no quotes will be included. |
| HeaderInQuotes | {On | Off} | Specifies whether or not quotes will be included around header data. |
| Headers | {One | All | None} | Define which headers are included in an exported report. The One keyword specifies that only the first header will be included in the report. The All keyword specifies that all headers will be included in the report. The None keyword specifies that no headers will be included. |
| UseCommaForDecPnt | {On | Off} | Specifies whether or not the decimal point in real numbers will be replaced with a comma. |
| KeepReportLines | {On | Off} | Specifies whether or not to display all report lines, including blank lines. |
| ShowStartStop | {On | Off} | Specifies whether or not to display the report's start and stop times at the top of the exported report. |
| WriteReportTitle | {On | Off} | Specifies whether or not to display the report title in the exported report. |
| WriteObjectNames | {On | Off} | Specifies whether or not to display object names in the report title of the exported report. WriteReportTitle must be On in order to see the object names. |
| WriteSectionTitles | {On | Off} | Specifies whether or not to display the section titles in the exported report. |
All export options will be applied:
- to a report created via the ReportCreate command with the Type Export option
- for a report created using the STK GUI, right click in the report body and select Export - To Excel or CSV Format.
Only these export options — Delimiter, HeaderInQuotes, Quotes, and UseCommaForDecPnt — will be applied:
- to a report created via the ReportCreate command with the Type Export and Summary options
- for a report created using the STK GUI, right click in the report body and select Export - Complete
When a report is created via the Report_RM command, only the following export options will be applied: Delimiter, Headers, HeaderInQuotes, Quotes, and UseCommaForDecPnt.
Examples
To set export options for the current connection:
To set export options for both the application and the current connection:
To save the current application export options to your _Default.ap file:
Return message
Group membership
This command belongs to the following group(s):
Version
6.2