Starting Foresight Analytics Platform Using Keys

Foresight Analytics Platform can be started from the command line using keys.

Syntax

cfg.exe -key;

 where "key" takes on the following values:

Key Description Files, with which it can be used
svccreate It creates the PPcfg update service. Cfg.exe
svcdelete It deletes the PPcfg update service. Cfg.exe
svcsetsec It sets permissions to control the PPcfg update service. Cfg.exe
noservice It cancels the PPcfg update service, update will be executed under the current user. Cfg.exe
singleinstance It activates previously opened window of Foresight Analytics Platform. Cfg.exe
customparam It passes a custom parameter to the system. It is used together with singleInstance. Cfg.exe
splash It enables the use of custom images in the login dialog box. Cfg.exe
locale It sets the Foresight Analytics Platform interface language. Cfg.exe, PP.exe, Studio.exe and Adm.exe
profile It enables the update or startup of Foresight Analytics Platform with the specified release number. Cfg.exe
silent It hides image displayed on starting Foresight Analytics Platform. Cfg.exe

Keys to Work with the PPcfg Service

The PPcfg service (Foresight Analytics Platform configuration service) is used on platform update. Installing Foresight Analytics Platform using the installer, the service is created automatically without any additional operations. One can check the service list in the computer to see if this service is available (see Control Panel -> Administrative Tools -> Services).

When it is explicitly required to:

The singleinstance and customparam Keys

Using the singleinstance key on startup enables the user to activate the previously opened window of Foresight Analytics Platform; otherwise it starts Foresight Analytics Platform.

When opened forms are present, the BeforeInstanceActivate command is sent to one of these forms. If the command is not recognized by the form, this command is sent to the next form, and so on. As soon as the command is accepted (the form returns the integer <> 0), the AfterInstanceActivate command is sent to this form. If all the forms return 0 or Null, the object navigator window is activated.

In order to recognize the sent commands, a form must be able to handle the Form.OnCommand event.

To send a certain parameter to the system, use the customparam key together with the singleinstance key. The custom parameter passed to the system is specified after the customparam key.

Syntax

Cfg.exe Username/Password@MetabaseId:ObjectId -singleinstance -customparam "parameter"

where:

The User name, Password, MetabaseId, and ObjectId parameters are optional.

Example

Cfg.exe PPUser/PPUser@PPScheme -singleinstance -customparam "test"

The splash Key

Using this key on starting Foresight Analytics Platform enables the user to show the file specified after the key as a splash screen. This file should be located in the root folder with installed Foresight Analytics Platform.

Syntax

Cfg.exe Username/Password@MetabaseId:ObjectId -splash "namefile"

where:

The Username, Password, MetabaseId, and ObjectId parameters are optional.

Example

Cfg.exe -splash "01.bmp"

After executing this command on starting Foresight Analytics Platform, the image stored in the 01.bmp file is displayed instead of the standard splash screen and then the standard login dialog box opens.

The locale Key

Using this key enables to start Foresight Analytics Platform with the specified interface language regardless of language settings. Use this key to start several instances of the platform in different languages.

Syntax

Cfg.exe -locale=<number>

where:

The following codes are available:

Example

Cfg.exe -locale=1034

Executing this command starts the platform with interface in Spanish.

The profile Key

The use of this key updates and starts the specified platform version. Settings are obtained from the profile saved to the registry on installing Foresight Analytics Platform: [HKEY_CURRENT_USER\Software\Foresight Analytics Platform\10.0\AutoUpdate\Profiles\<Profile name>].

By default, the profile name matches the release number, for example, 10.5.

Syntax

Cfg.exe -profile "version"

where:

Example

Cfg.exe -profile "10.5"

Executing this command updates or starts Foresight Analytics Platform.

The silent Key

This key hides the image displayed at startup of Foresight Analytics Platform.

Syntax

Cfg.exe -silent

Example

Cfg.exe -silent

After executing this command, the image is not displayed on startup of Foresight Analytics Platform.

See also:

Starting Platform from Command Line | Updating Platform