Load plant sample JSON request (SQL Server) - Intergraph Smart Engineering Manager - Help - Intergraph

Intergraph Smart Engineering Manager Smart API Help (2.0)

PPMProduct
Intergraph Smart Engineering Manager
PPMCategory_custom
Help
Version_WebSEM
2.0

  • Plant names must be unique in the database.

  • Backslashes used in paths must be doubled as shown below.

  • The example shown below is for a plant with all three applications associated and where all the applications are required in the copied plant. When loading a plant, ensure that applications not associated with the plant are excluded from the request.

  • Resource path strings are case-sensitive.

  • SQL Server database usernames cannot begin with a number, nor are they allowed to contain spaces and the following characters: " . < , > ? \ / ' ; { } [ ] ~ ` ! % * ( ) & $ @ #

  • SQL Server database passwords are not allowed to contain spaces and the following character: '

  • The database user names and passwords shown in the example are recommended values based on the name of your plant. For more information, see Assigning Database User Names.

{

"packagePath": "\\\\VSMSS16SEM\\AppMSS\\API_Sites\\WebAPISite01_MSS\\Plants\\Backups\\Copyof_WebAPIPlant01.zip",

"changeGuid": true,

"plant":

{

"Name": "WebAPIPlant02_MSS",

"Description": "Description of plant WebAPIPlant02_MSS",

"PlantStructurePath": "\\\\VSMSS16SEM\\AppMSS\\API_Sites\\WebAPISite01_MSS\\Plants\\WebAPIPlant02_MSS",

"PlantBackupLocationPath": "\\\\VSMSS16SEM\\AppMSS\\API_Sites\\WebAPISite01_MSS\\Plants\\Backups",

"SqlServerDatabaseNode": "mss16DBNode","SqlServerSystemUser": "sa","SqlServerSystemPassword": "Password.100",

"SqlServerDatabaseName": "WebAPIPlant02_MSS",

"SchemaSqlServerUserName": "WebAPIPlant02_MSS","SchemaSqlServerPassword": "WebAPIPlant02_MSS",

"DataDictSqlServerUserName": "WebAPIPlant02_MSSd","DataDictSqlServerPassword": "WebAPIPlant02_MSSd"

},

"applications":

[

{

"ApplicationType": "Sppid",

"SqlServerDatabaseName": "WebAPIPlant02_MSS",

"SchemaSqlServerUserName": "WebAPIPlant02_MSSpid","SchemaSqlServerPassword": "WebAPIPlant02_MSSpid",

"DataDictSqlServerUserName": "WebAPIPlant02_MSSpidd","DataDictSqlServerPassword": "WebAPIPlant02_MSSpidd",

"ReferenceDataPath": "\\\\VSMSS16SEM\\AppMSS\\API_Sites\\Reference Data\\P&ID Reference Data"

},

{

"ApplicationType": "Spel",

"SqlServerDatabaseName": "WebAPIPlant02_MSS",

"SchemaSqlServerUserName": "WebAPIPlant02_MSSel","SchemaSqlServerPassword": "WebAPIPlant02_MSSel",

"DataDictSqlServerUserName": "WebAPIPlant02_MSSeld","DataDictSqlServerPassword": "WebAPIPlant02_MSSeld",

"RefSchemaSqlServerUserName": "WebAPIPlant02_MSSelref","RefSchemaSqlServerPassword": "WebAPIPlant02_MSSelref",

"ReferenceDataPath": "\\\\VSMSS16SEM\\AppMSS\\API_Sites\\Reference Data\\SEL Reference Data"

}

]

}

JSON request parameters

Parameter

Value

Description and Comments

packagePath

Name and path of the .zip file for the plant to be loaded

changeGuid

true / false

A value of 'true' creates new identifiers when copying the plant. A value of 'false' retains the existing identifiers from the copied plant - this option is useful when working in an integrated environment when loading a plant with externally-modified data without the need to re-correlate the items when publishing to SmartPlant Foundation.

plant

Section under which plant parameters are specified

Name

<Plant Name>

Must have a unique value in the database

Description

Optional field

Type any text string or set value to 'null'

PlantStructurePath

<path for plant structure location>

PlantBackupLocationPath

<path for plant backup file location>

SqlServerDatabaseNode

SQL Server server name

Can be the server on which the site .ini file is located

SqlServerSystemUser

The case-sensitivity of this value depends on how the DBA defines it for the database

SqlServerSystemPassword

SqlServerDatabaseName

Can use name of plant

SchemaSqlServerUserName

Can use name of plant

SchemaSqlServerPassword

Can use name of plant

DataDictSqlServerUserName

Can use name of plant+'d'

DataDictSqlServerPassword

Can use name of plant+'d'

applications

Section under which application parameters are specified

ApplicationType

Sppid (for Smart P&ID)

Spel (for Smart Electrical)

Specify the applications you want to include when loading the plant. Delete the section for each application you do not want to include.

For details of the rest of the application JSON request parameters, see the list of parameters and their values for the appropriate applications and database platform under Associate application.