Command line usage for the Loader - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

You must run the command line loader from the directory where the Loader exists. The loader is typically in C:\Program Files (x86)\SDX\SPFDesktopClient\CurrentVersion.

If you want to run the loader by specifying the full path of the spfdataloader.exe in the command prompt, then you must check that the Icons folder is present at the location specified in the settings.xml file. For example, if C:\Temp\Test is the current working directory, and you are trying to run the loader by specifying C:\Program Files (x86)\SDX\SPFDesktopClient\CurrentVersion\SPFDataLoader.exe in the command prompt, you may encounter an exception if the Icons folder does not exist. So, make sure to create the Icons folder at C:\<Icons folder>, if that is the folder set in the .ini file.

The command line options for the Loader are very similar to the command line options for the Desktop Client; they are as follows:

"/U" user

"/P" password

"/PLANT" – plant

"/PROJECT" - project

"/S" - Server (you do not need the following two options with this)

"/H" – host (this option needs the following option as well)

"/W" – web directory

"/F" – file name

"/UI" – Display loader window. User required to start load process manually

"/secure" - Secure site. Boolean indicating a secure site

"/outputpath" - log file output path

The code first tries to log in from the command line. If not enough information is present to log in and find the requested file, it will remember the information it does have and prompt the user for the rest.

spfdataloader.exe /U adminuser /P /S Server /F "c:\temp\Vault and Host.xml"

  • If no argument is provided to specify a configuration (plant or project), the loader will use the last create scope set for the user in the Desktop Client. Configuration information provided in the load file will take precedence over information provided in the command line argument or previous Desktop Client settings.

  • When a load fails, output files are generated in the same way, whether the files were loaded through the Desktop Client or the command line.

  • The command line loader does not honor the permissions set for users. For example, a user without the permission to load files and create objects can use the command line loader to upload files and create objects in the database.