Upgrade a site from the command line - SmartPlant Foundation - IM Update 46 - Administration & Configuration

SmartPlant Foundation Server Manager Help

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

Use SPFServerManager.exe with the /upgrade argument to update a site. You must provide information about the new site using several additional arguments:

/sn: - names the site; "server" is appended to the name automatically (required).

/from: - identifies the SmartPlant Foundation version of your SmartPlant Foundation site database. For example, if you are upgrading from version 10.00.23.0192, enter 10.00.27.0164 to upgrade to the latest update 27 version. The format should be xx.xx.xx.xxxx.

SHARED Tip The available /from values are listed in the UpgradeControls.xml file located at: [drive]:\Program Files (x86)\SPF\SPFServerManager. For example, if you are upgrading from:

  • SmartPlant Foundation Update 23 - the /from value would be 10.00.23.0192.

  • SmartPlant FoundationUpdate 24 - the /from value would be 10.00.24.0177.

  • SmartPlant Foundation Update 26 - the /from value would be 10.00.26.0183.

/upgradedataindb: - indicates if the data in the database should be upgraded. The default setting is True.

/backupdb: - backs up the database before the upgrade. The default setting is False.

/dbpath: - identifies the path of the database back up file to which the data is exported. If the path is not defined, by default, it is exported to the backup folder located in the default server files folder. For example, [drive]:\SmartPlant Foundation Server Files\Backups. The default server files location is read from the Settings.xml file located at: [drive]:\ProgramData\SPFServerManager.

/upgradecmf: - upgrades the configuration managed file (CMF). The default setting is False.

/cmfpath: - identifies the customized CMF file.

/out: - specifies a path and filename for outputting log information to a JSON file. For example, /out:”d:\test\output.json”

This example upgrades a site called SPF and identifies the version you are upgrading from.

SPFServermanager.exe /upgrade /sn:SPFserver /from:10.00.23.0192

This example upgrades a site called SPF, identifies the version you are upgrading from, and backs up the database before the upgrade.

SPFServermanager.exe /upgrade /sn:SPFserver /from:10.00.23.0192 /backupdb:true

The backup path default is C:\SmartPlant Foundation Server Files\BackUps.

This example upgrades a site called SPF, identifies the version you are upgrading from, and backs up the database before the upgrade to the path of the database back up file to which to export data.

SPFServermanager.exe /upgrade /sn:SPFserver /from:10.00.23.0192 /backupdb:true /dbpath:"C:\Program Files (x86)\backups"

SHARED Tip This example uses the /log: argument to generate a log file that stores results and errors from the operation. Specify a path and file name for the target log file (an extension is not required for the file).

SPFServermanager.exe /create /sn:SPFserver /db:Oracle /dsn:SPFSvr1 /u:SPFSvr_data /p:password /log:"C:\SmartPlant Foundation Server Files\Temp\ServerManager\SPFcreation"

If the SPFcreation.log argument is not included, a log file is created by default in C:\SmartPlant Foundation Server Files\Temp\ServerManager. The ConsoleLog_TimeStamp.txt is included which references the console output results.

This example upgrades a site called SPF, identifies the version you are upgrading from, backs up the database before the upgrade, and upgrades the CMF.

SPFServermanager.exe /upgrade /sn:SPFserver /from:10.00.23.0192 /backupdb:true /upgradecmf:true /cmfpath:"C:\SmartPlant Foundation Server Files\EFSchema.cmf"

This example only upgrades the CMF and does not upgrade data in database or back up the database.

SPFServermanager.exe /upgrade /sn:SPFserver /from:10.00.23.0192 /upgradedataindb:false /upgradecmf:true /cmfpath:"C:\SmartPlant Foundation Server Files\EFSchema.cmf"