Command line parameters - SmartPlant Foundation - IM Update 38 - Installation & Upgrade

SmartPlant Foundation Desktop Client Workstation Setup

Language
English
Product
SmartPlant Foundation
Search by Category
Installation & Upgrade
SmartPlant Foundation / SDx Version
10

Parameter

Description

U

User name

P

Password

PLANT

Plant name

PROJECT

Project name

H

Host

S

Server name (as defined in the logon dialog box)

W

Web directory

CURRDIR

Current directory

SECURE

True/False: if logging on to server using SSL

SINSTANCE

True or False: specifies whether to use a single instance or multiple instances of Desktop Client

ENABLEDEBUG

True/False: Enables debugging and creates a log file, SPFOpen.log, in the local temp file location (%TEMP%). This parameter is valid only for URLs

VERSION

Version of the software to run; accepts values in form 00.00.00 or 0.0.0 (ex. 05.01.10 or 5.1.10); default is the largest version number installed in the C:\Users\[UserName] \AppData\Roaming\SmartPlant\Foundation folder. This parameter is valid only for URLs using SPFOpen

M

Module to open after logging on to the SmartPlant Dashboard. Only used with Desktop_Client.exe at the command line. Other commands ignore this parameter. SPFClientModule opens the Desktop Client, SPFBIModule opens the SmartPlant Business Intelligence module, SPFReportAdministrationModule opens the Report Administration module.

The following details logon parameter behavior, depending on what you specify in the command line or URL. The following are provided in command line format. They can also be used in the URL format.

/U /P /PLANT /PROJECT /S
Logs you in as the user specified with the plant/project specified on the given server if the server is not authenticated. The user and password are ignored if the server is authenticated. If the server is authenticated, the Logon dialog box appears with the User name and Password boxes disabled, and the Server list to select the correct server.

/U /P /PLANT /PROJECT /H /W
Same as the previous example, but uses the host and web directory instead of the server.

/U /P /PLANT /PROJECT /S /M
Same as the first example, but, if using with Desktop_Client.exe at the command line, opens the named module directly instead of the SmartPlant Dashboard.

/U /P /PLANT /PROJECT
A Logon dialog box appears with the User name and Password boxes populated.

/S /PLANT /PROJECT
If the server is authenticated, this command logs you on to the Desktop Client. Otherwise, the Logon dialog box appears with the Server list disabled, but displays the specified server. If the server specified is not defined, a message box appears to inform the user, and the logon process stops.

/H /W /PLANT /PROJECT
Same as the previous example except that if the specified Web host and Web directory have not been defined, a new server is created from these. If the new server is authenticated, this logs you on. Otherwise, the Logon dialog box appears with the Server list disabled, but displays the specified server.

/PLANT /PROJECT
Displays the Logon dialog box, but once you select a server and log on, the specified Plant and Project is honored.

  • If you do not specify any command line parameters, the Logon dialog box appears.

  • When using Desktop_Client.exe at the command line or in a shortcut, if you do not specify a module using the /M parameter, the SmartPlant Dashboard is displayed after logon.

  • If you select an authenticated server from the list, the User name and Password boxes are disabled. They are enabled if you select a server that is not authenticated.

  • If a server is not responding, a message box appears to tell the user, and the OK button is disabled. The OK button is enabled if you select another server that is responding.

  • When using the /SECURE switch, you may need to adjust the timeout setting in your web.config file to keep the login attempt from timing out while the secure login is processing. If this occurs, add or edit the following key in the web.config file with the following value: <add key="IsResponding.Timeout" value="600" />.

  • The logon parameters are case-sensitive.

  • When you use the /SINSTANCE parameter in combination with the /S parameter to specify a site or the /H and /W parameters to specify a combination of host and web directory, if you attempt to launch another instance specifying another site, host, or web directory, the connection will not be allowed. The /SINSTANCE parameter allows only a single instance to be connected at any given time. To connect to another site, the current instance must be closed.

Examples

Desktop_Client.exe /U abc /P /S SPF42 /M SPFClientModule

Desktop_Client.exe /U abc /P /PLANT Plant1 /PROJECT Project1 /S SPF42 /M SPFClientModule

Desktop_Client.exe /SINSTANCE True /U abc /P Plant1 /S SPF42 /M SPFClientModule

SPFOpen:U=abc^P=^PLANT=Plant1^PROJECT=Project1^S=SPF42