Using Command Line

Foresight Analytics Platform can be started from the command line by using specific syntax (shown below), for example, for automatic connection to repository and/or opening an object. When the platform is started from the command line, keys can be used.

Foresight Analytics Platform can also be started by selecting in the Windows start menu the Foresight Analytics Platform 10.5 > Foresight Analytics Platform 10.5 (see details in the Getting Started with Desktop and Web Applications section).

Starting Foresight Analytics Platform from Command Line

Foresight Analytics Platform can be started from the command line with automatic connection to repository and starting any repository object.

NOTE. Execution module cannot be started from the command line.

Syntax

Studio.exe [/user:Username] [/password:Password] /scheme:MetabaseId [/sysdata::ObjectID|::#Object.Edit]

where:

Studio.exe. Startup file; you can also use PP.exe or Cfg.exe.
Username. User name.
Password. User password.
MetabaseId. Identifier of a repository registered in the registry. To connect to the default repository, use the %DefaultRepository% or ^DefaultRepository^ substitutions. If the registry does not have the record of the default repository, the system login dialog box opens.

NOTE. If the system starts from the command line (cmd.exe), the ^DefaultRepository^ substitution should be escaped with the ^ character, that is, ^^DefaultRepository^^.

/sysdata::. The block of additional parameters determining the repository object to be opened.
ObjectId. Key or identifier of repository object for starting. This object will be automatically started upon successful repository connection. If a form is selected as object to be started, the use of the -singleinstance and -customparam keys can be relevant.
|::#Object.Edit. The command which opens the selected object for edit.

NOTE. When the object is opened for edit, the /sysdata::ObjectID|::#Object.Edit block should be enclosed in quotation marks.

All parameters except for MetabaseId are optional.

If the user name is not specified, integrated domain authorization is used. If the object to be started is not specified, it will be taken from settings of the specified user.

If the user password does not contain special characters and it contains only numbers, letters or underscore, the simplified syntax can be used:

Studio.exe Username/Password@MetabaseId:ObjectId|::#Object.Edit

On using the simplified syntax, the %DefaultRepository% substitution is used to connect to repository.

NOTE. On opening the object for edit, the ObjectId|::#Object.Edit block should be enclosed in quotation marks. The simplified syntax is outdated, it is kept for compatibility with previous versions of Prognoz Platform.

Examples

Studio.exe /user:PPUser /password:PPUser /scheme:ppScheme

Studio.exe PPUser/PPUser@ppScheme

Foresight Analytics Platform is started with connection to the ppScheme repository without displaying the login dialog box after executing this command.

Studio.exe /user:PPUser /password:PPUser /scheme:^DefaultRepository^

Studio.exe PPUser/PPUser@%DefaultRepository%

Foresight Analytics Platform is started with connection to the default repository after executing the command. The system login dialog box opens if no default repository is determined.

Studio.exe /user:PPUser /password:PPUser /scheme:ppScheme /sysdata::MainForm

Studio.exe PPUser/PPUser@ppScheme:MainForm

Foresight Analytics Platform is started with connection to the ppScheme repository without displaying the login dialog box after executing the command. After that the specified repository object is opened for view.

Studio.exe /user:PPUser /password:PPUser /scheme:ppScheme "/sysdata::MainForm|::#Object.Edit"

Studio.exe PPUser/PPUser@ppScheme:"MainForm|::#Object.Edit"

NOTE. Object editing is available only after Foresight Analytics Platform is started using the Studio.exe or Cfg.exe files. The command is available for the Cfg.exe file on the installed FP10Full distribution file version.