Command line arguments to the TextFormatter

The usual way to execute the Text Formatter is via the Formatter Launcher Dialog in the GFE which automatically generates a command line from the Text Product definiton. However, the program can be run stand-alone with the following command and arguments. To see the set-up of these arguments for a given text product, examine the Process Monitor window.

runIFPText -d database -t forecastType [-c configFile] [-o outputFile] [-u username] [-l language] [-A appendFile] [-V {varDict}] [-O serverFile] [-S gfeGenOutputFile] [-site siteID] [-z drtOffset] [-a vtecActiveTableName] [-T] [-E] [-v vtecMode] [-r editAreaName] [-w timeRangeName] [-s startTime -e endTime] [-i period]

Switch
 Optional
 Example
 Purpose
-d database
 No
 -d BOU_GRID__Official_00000000_0000
 Defines the source database for the gridded information.
-t forecastType
 No
 -t ZFP
 Defines the Forecast Type.
-c configFile
 Yes
 -c localGfeConfig
 Defines the GFE config file. Default is gfeConfig.
-o outputFile
 Yes
 -o /tmp/123.txt
 Output file for text product.
-S gfeSpecialOutputFile
 Yes
 -S /tmp/10234783.txt
 This is a special filename that is used for background processing text formatters to store the output forecast text. The GFE puts on this switch for formatters that are run locally by the GFE so the forecast text may be gathered at the end of the formatter execution. Formatters run by EDEX put on this switch for the same purpose. The connection allows for proper behavior in the GFE's Formatter Launcher and Process Monitor.
-site siteID
 Yes
 -site bou
 Defines the site id to use.
-u userName
 Yes
 -u mark
 Specifies the user name under which to run the formatter.
-l language
 Yes
 -l spanish
 Used for formatters that support foreign languages. The options are "spanish" and "french". Default is "english".
-A appendFile
 Yes
 -A /tmp/123.txt
 Append filename. Output text is appending to specified file.
-V varDict
 Yes
 -V '{("Product Issuance", 'productIssuance"):"Morning"}'
 VariableList values from user interface dialog.
-O serverFile
 Yes
 -O test123
 Output file in the server's product drafts directory.
-z drtOffset
 Yes
 -z 20041020_1211
 Specifies the Displaced Real-Time Time
-T
 Yes
 -T
 Places the formatter into "TEST" mode. If vtecMode is specified, it is set to "T". "TEST" mode adds ...TEST... to headlines and MND headers.
-E
 Yes
 -E
 Places the formatter into "EXPERIMENTAL" mode. If vtecMode is specified, it is set to "E". "EXPERIMENTAL" mode adds "EXPERIMENTAL..." to the MND header.
-v vtecMode
 Yes
 -v "O"
 Specifies the VTEC code ('X', 'O', 'T', 'E') for the product. If not specified, then VTEC is disabled for the product.
-a activeTableName
 Yes
 -a PRACTICE
 Defines the active table to use for VTEC comparisons. If not specified, uses the operational "active" table.
-r
 Yes
 -r CO_Adams
 Used for Simple Table products to specify Edit Area over which to run table
-w
 Yes
 -w Today
 Used for Simple Table products to specify named Time Range over which to run table
-s
 Yes
-s 20041213_1200 Used for Simple Table products to specify the start time over which to run table (Must also include and end time)
-e
 Yes
 -e 20041216_1200 Used for Simple Table products to specify the end time over which to run table (Must also include and start time)
-i
 Yes
 -i 3
 Used for Simple Table products with variable period (for rows or columns)
The -E and -T switches are mutually exclusive.

-V Switch - run-time VariableList

This option to provide a run-time VariableList instead of displaying the user dialog.

The dictionary must be in the form of a Python dictionary string. For example:

  -V  '{("Product Issuance", "productIssuance"):"Morning", ("Issuance Type", "issuanceType"):"Routine"}'