Command line parameters are typically used when launching Smart Construction from another application. They allow you to control who the user logs in as and what plant/project access they have. The command line parameters can also be used to log on to the Smart Construction client.
When launching Smart Construction from the command line, all parameters begin with a slash ( / ) and require a colon (:) between the parameter and the value. If the value contains spaces, it must be enclosed inside double quotation marks (" "). The parameter values for /Roles: and /P: are case sensitive.
Logon Parameters
|
Parameter |
Description |
|---|---|
|
/U: |
User |
|
/P: |
Password |
|
/S: |
Server |
|
/H: |
Host |
|
/W: |
Web directory |
|
/Plant: |
Plant |
|
/Project: |
Project |
|
/Roles: |
Roles |
|
/Secure: |
True/False: if logging on to server using SSL |
|
/O: |
Opens windows from the Smart Construction Home Page. Use the Workspace Item name in SmartPlant Foundation Desktop Client as the parameter. |
SPC.Client.exe /? or SPC.Client.exe /help displays help for command line parameters
in the command prompt window.
Detailed below is the behavior, depending on what you pass in on the command line:
/U: /P:
This autopopulates the user name and password in the client.
/U: /P: /Plant: /Project: /S:
This 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 displays with the User name and Password disabled, and the Server list is set to the correct server.
/U: /P: /Plant: /Project: /H: /W:
This is the same as the previous example, but it uses the host and web directory instead of the server.
/U: /P: /Plant: /Project:
A logon dialog box displays with the User name and Password boxes populated.
/S: /Plant: /Project:
If the server is authenticated, this logs you on to Smart Construction. If the server is not authenticated, the logon dialog box displays with the Server list disabled showing the specified server.
/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. If the new server is not authenticated, the logon dialog box displays with the Server list disabled showing the specified server.
/Plant: /Project:
This displays the logon dialog box, but once you have selected a server and logged on, the specified Plant and Project are honored.
/U: /S: /O:
This logs onto the server and opens a specified window from the Home Page.
-
If you do not specify any command line parameters, the logon dialog box displays.
-
If you pick an authenticated server from the list, the User name and Password are disabled. They are enabled if you pick a server that is not authenticated.
-
If a server is not responding, a message box displays to tell the user, and the OK button is disabled. The OK button is enabled if you select another server that is responding.
Examples
SPC_Client.exe /U:[UserName] /P:[Password] /S:[ServerName]
SPC_Client.exe /U:[UserName] /P:[Password] /PLANT:[PlantName] /PROJECT:[ProjectName] /S:[ServerName]
SPC.Client.exe /U:[UserName] /S:[ServerName] /O:"Work Packages"