Display site settings in JSON format 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 /siteinfo argument to return the property settings for a site and display the information in JSON format or output as a JSON file. The information can be used by administrators to update or deploy their sites. You must provide information about the site and the property settings using additional arguments:

/sn: - names the site to be checked for its settings.

/databaseversion: - returns the data base version.

/displaylog: - writes the JSON information to the log file for the site. The default is true.

/installedversion: - returns the installed version.

/isprimarysite: - returns whether the site is a primary site.

/isupdateneeded: - returns whether the site needs to be updated.

/isupgradeneeded: - returns whether the site needs to be upgraded.

/iwastatus: - returns the status of IWA authorization.

/siteversion: - returns the site version.

/sitepath: - returns the path of the site.

/out: - the fully qualified path for where the JSON file output is to be written.

<any setting>: - reads the configuration file and returns the value of that setting.

/sessions:all - returns all the login sessions for the selected site.

/sessions:active - returns all the active login sessions for the selected site.

/sessions:inactive - returns all the inactive login sessions for the selected site.

/sessions:expired - returns all the expired login sessions of the selected site.

/databaselayers - returns the database layers associated with site.

/st:[Server|WebClient|License] – specifies if the site being named is a primary site on the application server, or a Web Client site, or a license site; required when two different sites have the same name. Otherwise this argument is optional.

This example returns all the settings from the SDxWC site.

SPFServermanager.exe /siteinfo /sn:SDxWC

This example shows the site information for the primary site when the names of both the primary and Web Client site are the same:

SPFServermanager.exe /siteinfo /sn:SDxWC /st:Server

This example returns all the settings from the siteSDxWC and outputs the information in a JSON file.

SPFServermanager.exe /siteinfo /sn:SDxWC /out:”d:\test\output.json”

This example returns the data base version for the site SPF2019.

SPFServermanager.exe /siteinfo /sn:SDxWC /databaseversion

This example returns the data base version and writes the information to the log file for the site SPF2019.

SPFServermanager.exe /siteinfo /sn:SDxWC /databaseversion /displaylog:true

If set to false, just the data base version for the site SDxWC is returned.

This example uses multiple values in a single command line.

SPFServermanager.exe /siteinfo /sn:SDxWC /isupgradeneeded /”user id” /databasetype

For arguments that contain a value, you must use quote marks around the value if there are spaces in the string.

This example uses multiple values in a single command line and outputs the information in a JSON file.

SPFServermanager.exe /siteinfo /sn:SDxWC /isupgradeneeded /”user id” /databasetype /out:”d:\test\output.json”

This example returns all the settings from the SDxWC site.

SPFServermanager.exe /siteinfo /sn:SDxWC

This example returns the authorization URL setting from the SDxWC site.

SPFServermanager.exe /siteinfo /sn:SDxWC /authorization:url

SHARED Tip Alternatively, you can use the display name for the setting, such as "OAuth URL". For example:

SPFServermanager.exe /siteinfo /sn:SDxWC /"OAuth URL"

Service settings

If you want to return specific site service settings, you must prefix the value with the service initials. This is because some settings are common across different sites.

Service Name

Prefix

Examples

File service

FS

"FS_WebGLConversion.Timeout"

"FS_DaysBeforeCleanup"

Remote service

RS

"RS_XMLCompression.Enabled"

"RS_ProcessTimeOutForPrint"

FTR service

FTR

"FTR_InternalServicesIWAEnabled"