GFE Startup Information

December 16, 2005

Table of Contents

Command Line Options
Standard Startup of GFE
Special Configuration Files
Special GFE Startup Modes for TEST and PRACTICE

Command Line Options

runGFE [-h hostname] [-p portNumber] [-c configFile] [-u userName] [-t networkTimeout] [-m mutableModel] [-z drtTime] [-f specialMode] [-a] [-i dbCategories]

Command Line Option Optional? Meaning

-h hostname YES Identifies the hostname upon which the ifpServer is running. During installation, this value is automatically set, but may be overridden.

-p portNumber YES Identifies the RPC portnumber upon which the ifpServer is running. During installation, this value is automatically set, but may be overridden.

-c config YES Identifies the gfe configuration file to use for the session. If the -u and -c switches are specified, then the startup dialog will not contain entry boxes for the user to choose the config file.

-u username YES Specifies the user id to be used for the GFE session. This affects the availability of metadata to the GFE. See the base, site, and user configuration guide for details. If the -u and -c switches are specified, then the startup dialog will not contain entry boxes for the user to choose the username.

-t networkTimeout YES Normally defaults to 60 seconds. In heavy network situations, may need to increase this value to prevent the GFE/ifpServer from timeouts.

-m mutableModel YES The mutable model is stored in the gfe configuration file. It can be overriden through this switch. Note that the format is in the form of type_model or type_model_time, such as "_Fcst" or "_NAM_20021002_1200.

-z drtTime YES The GFE may be started in the Displaced Real Time Mode.

-f specialMode
YES
By default, this switch is not provided. If provided, will bring up the GFE in a special mode. The two special modes supported are TEST and PRACTICE. These modes are product-generation specific.

-i dbCategories YES The database viewable categories are stored in the gfe configuration file. It can be overriden through this switch. Note that the format does not normally include the time. The normal format is type, such as "" for no-type or "D2D" for d2d-type databases. There can be multiple -i switches.

-a
YES
Force AWIPS mode. If this switch is set, then the -f switch determines the only possible modes that are available to choose from. For example, with -f TEST and no -a switch, the GFE is started in TEST mode but can be switched to PRACTICE or OPERATIONAL mode. With the -f TEST and -a switch, the GFE is started in TEST mode and cannot be switched to another mode.

Standard Startup of GFE

GFE is normally started with just the runGFE script and no switches. When this is done, the GFE begins and contacts the ifpServer. If the ifpServer cannot be connected successfully, an error dialog is presented to the user.

In normal situations once the server has been contacted, the user is presented with the GFE start up dialog. The known list of user names will appear in the left listbox. The user can click on an existing name in the list, or add a new name by typing the user name identifier in the entry field. Once a user name has been selected, the GFE will query the ifpServer and determine the available list of configuration files that are available to the user. The standard "gfeConfig" is shipped with the system. The site may have overridden it and user's may override them too. See the base, site, user concepts guide for information. The gfe configuration file can be tailored to the site's or user's needs. See the gfe configuration guide for details. The user selects the appropriate configuration file from the list. The user is not allowed to enter a new configuration file since the gfe requires an existing configuration file to start.

The third column is the GFE mode. It defaults to the modes specified by the command line switches. If no mode is specified via the command line, the mode is set to "operational". The user can change the mode to "test" for product live comms testing, or one of the two practice modes. Refer to the Special GFE Startup Modes for TEST and PRACTICE.

The user positions the cursor over the START button and clicks. The GFE will now start and just the splash screen will be shown:

If the GFE does not come up properly, ia bad configuration file is likely the cause and a dialog shows the location of the error:

Special Configuration Files

The GFE comes with some special configuration files which can be used to modify special grids. If a GFE is started as the SITE user using one of these files, then various special weather elements can be edited.

EditTopo

Starting the GFE as the SITE user with this config file (runGFE -u SITE -c EditTopo), allows for the editing of the topo grid. You can also use the standard startup runGFE, and enter EditTopo into the configuration column of the startup dialog.

Once the GFE is running, there will be no weather elements appearing in the grid manager. One weather element will be loaded, of a persistent nature, into the spatial editor. This element is called Topo SFC Topo_EditTopo. You can edit the topography and once saved, the remainder of the GFESuite system will see the modified topography when those programs are started.

Special GFE Startup Modes for Test and Practice

The GFE may be started with three special modes. These modes allow for product testing and GFE practice. This section defines the behavior of the GFE in these modes.

TEST mode

Starting the GFE with a -f TEST switch will place the GFE in TEST mode. All products issued in this mode will be issued with TEST mode enabled. The forecaster edits a Test database instead of a Fcst database, thus no impact is made on formal operations.

Test mode on products means that products that normally have VTEC will have the "T" code enabled, regardless of the definition in the VTECMessageType file (as long as there is a definition for the product in the VTECMessageType file). Test products mean that the MND header will contain the "...TEST..." and so will any headlines in the product.

The characteristics of the GFE is changed while in TEST mode:

The forecaster edits a Test database instead of a Fcst database, thus no impact is made on formal operations.
Product can be transmitted.
There is no Official database available.
Sending of ISC grids and Publishing to Official is disabled.
The FormatterLauncher data source is set to the Test database.
The VTEC "active" table is used since these products can be transmitted.
The enabled VTEC modes specified in VTECMessageType is used only to determine if VTEC is enabled or not for a product. If a product does not normally contain VTEC, then in TEST mode no VTEC will appear. However, if vtec is enabled for a product, that vtec mode is switched to "T" mode.
The background color of the GFE is changed, to make it clear to the forecaster that they are in a special mode. The word TEST is placed in the window manager title.

An example of the GFE in TEST mode is shown below:

PRACTICE mode

Starting the GFE with a -f PRACTICE switch will place the GFE in PRACTICE mode. In this mode the following characteristics are changed:

The forecaster edits a Practice database instead of a Fcst database, thus no impact is made on formal operations.
There is no Official database available.
Sending of ISC grids and Publishing to Official is disabled.
The FormatterLauncher data source is set to the Practice database.
An alternate active table is used to ensure there is no conflict with real operations.
The ability to store products in the AWIPS text database and transmit them is not available, although the GUI will still exist. The Transmit GUI will clearly indicate that the transmit is being simulated.
A special Formatting entry appears on the Formatter Launcher to allow the forecaster to select the type of practice formatting. Choices range from the 3 operational VTEC modes and no VTEC for operational/normal wording, and two choices for test wording (with and without VTEC).
The background color of the GFE is changed, to make it clear to the forecaster that they are in a special mode. The word PRACTICE is placed in the window manager title.

The background of the GFE in Practice mode appears orange:

Command Line Option	Optional?	Meaning
-h hostname	YES	Identifies the hostname upon which the ifpServer is running. During installation, this value is automatically set, but may be overridden.
-p portNumber	YES	Identifies the RPC portnumber upon which the ifpServer is running. During installation, this value is automatically set, but may be overridden.
-c config	YES	Identifies the gfe configuration file to use for the session. If the -u and -c switches are specified, then the startup dialog will not contain entry boxes for the user to choose the config file.
-u username	YES	Specifies the user id to be used for the GFE session. This affects the availability of metadata to the GFE. See the base, site, and user configuration guide for details. If the -u and -c switches are specified, then the startup dialog will not contain entry boxes for the user to choose the username.
-t networkTimeout	YES	Normally defaults to 60 seconds. In heavy network situations, may need to increase this value to prevent the GFE/ifpServer from timeouts.
-m mutableModel	YES	The mutable model is stored in the gfe configuration file. It can be overriden through this switch. Note that the format is in the form of type_model or type_model_time, such as "_Fcst" or "_NAM_20021002_1200.
-z drtTime	YES	The GFE may be started in the Displaced Real Time Mode.
-f specialMode	YES	By default, this switch is not provided. If provided, will bring up the GFE in a special mode. The two special modes supported are TEST and PRACTICE. These modes are product-generation specific.
-i dbCategories	YES	The database viewable categories are stored in the gfe configuration file. It can be overriden through this switch. Note that the format does not normally include the time. The normal format is type, such as "" for no-type or "D2D" for d2d-type databases. There can be multiple -i switches.
-a	YES	Force AWIPS mode. If this switch is set, then the -f switch determines the only possible modes that are available to choose from. For example, with -f TEST and no -a switch, the GFE is started in TEST mode but can be switched to PRACTICE or OPERATIONAL mode. With the -f TEST and -a switch, the GFE is started in TEST mode and cannot be switched to another mode.