Foresight Analytics Platform can be started from the command line using keys.
cfg.exe -key;
where "key" takes on the following values:
| Key | Description | Files, with which it can be used |
| svccreate | Creates the PPcfg update service. | Cfg.exe |
| svcdelete | Deletes the PPcfg update service. | Cfg.exe |
| svcsetsec | Sets permissions to control the PPcfg update service. | Cfg.exe |
| noservice | Cancels the PPcfg update service, update is to be executed under the current user. | Cfg.exe |
| singleinstance | Activates previously opened window of Foresight Analytics Platform. | Cfg.exe |
| customparam | Passes a custom parameter to the system. It is used together with singleInstance. | Cfg.exe |
| splash | Enables the use of custom images in the login dialog box. | Cfg.exe |
| locale | Sets the Foresight Analytics Platform interface language. | Cfg.exe, PP.exe, Studio.exe and Adm.exe |
| profile | Enables to update or start Foresight Analytics Platform with the specified release number. | Cfg.exe |
| silent | Hides image displayed on starting Foresight Analytics Platform. | Cfg.exe |
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:
Create a service, use the svccreate key.
Delete a service, use the svcdelete key.
Grant permissions, use the svcsetsec key.
Disable a service, use the noservice key. The update is to be executed under the current user.
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 open 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.
Cfg.exe Username/Password@MetabaseId:ObjectId -singleinstance -customparam "parameter"
where:
User name - user name.
Password - user password.
MetabaseId - identifier of the repository registered in the registry.
ObjectId - identifier of the repository object to be started. This object will be automatically started upon successful database connection.
Singleinstance - key.
Customparam - key.
Parameter - custom parameter.
The User name, Password, MetabaseId, and ObjectId parameters are optional.
Cfg.exe PPUser/PPUser@PPScheme -singleinstance -customparam "test"
If the PPScheme has been opened before executing the command and the form, which contains the required event has been started, the output form gets corresponding commands and the test parameter is passed to the form.
If the PPScheme has been opened before executing the command, the object navigator is activated as the result of executing the command.
If the platform has been closed, executing the command starts the platform with connection to the PPScheme repository without displaying the login dialog box.
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 must be located in the root folder with installed Foresight Analytics Platform.
Cfg.exe Username/Password@MetabaseId:ObjectId -splash "namefile"
where:
Cfg.exe - startup file.
User name - user name.
Password - user password.
MetabaseId - identifier of the repository registered in the registry.
ObjectId - identifier of the repository object to be started. This object will be automatically started upon successful database connection.
Splash - key.
Namefile - file name.
The User name, Password, MetabaseId, and ObjectId parameters are optional.
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 appears.
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.
Cfg.exe -locale=<number>
where:
number - identifier of language and regional settings.
The following codes are available:
1049. Russian.
1033. English.
1034. Spanish.
1040. Italian.
1087. Kazakh.
2052. Chinese (simplified).
1031. German.
1058. Ukrainian.
1036. French.
2070. Portuguese.
1025. Arabic.
14337. Arabic (United Arab Emirates).
Cfg.exe -locale=1034
Executing this command starts the platform with interface in Spanish.
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\9.0\AutoUpdate\Profiles\<Profile name>.
By default, the profile name matches the release number, for example, 9.2.
Cfg.exe -profile "version"
where:
version - number of release (version).
Cfg.exe -profile "9.2"
Executing this command updates or starts Foresight Analytics Platform.
This key hides the image displayed at startup of Foresight Analytics Platform.
Cfg.exe -silent
Cfg.exe -silent
After executing this command, the image is not displayed on startup of Foresight Analytics Platform.
See also: