-
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.
-
Database usernames are not allowed to contain spaces and the following characters: . < , > ? \ / ' ; { } [ ] ~ ` ! % * ( ) & $ @ # " - + ^ = | In addition, SQL Server database usernames are not allowed to begin with a number.
-
Oracle database passwords are not allowed to contain spaces or the following characters: ' $ @ "
-
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": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Plants\\Backups\\Copy_of_WebAPIPlant01.zip",
"changeGuid": true,
"plant":
{
"Id": "WebAPIPlant02",
"Name": "WebAPIPlant02",
"Description": "Description of plant",
"PlantStructurePath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Plants\\WebAPIPlant02",
"PlantBackupLocationPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Plants\\Backups",
"DatabaseServer": "SemserverORA",
"SystemUser": "<SysUser>","SystemPassword": "<Password>",
"SchemaUserName": "WebAPIPlant02","SchemaPassword": "WebAPIPlant02",
"DataDictUserName": "WebAPIPlant02d","DataDictPassword": "WebAPIPlant02d",
"SchemaTablespace": "USERS","SchemaTempTablespace": "TEMP",
"DataDictTablespace": "USERS","DataDictTempTablespace": "TEMP"
},
"applications":
[
{
"ApplicationType": "Sppid",
"ApplicationType": "Sppid",
"SchemaUserName": "WebAPIPlant02pid","SchemaPassword": "WebAPIPlant02pid",
"DataDictUserName": "WebAPIPlant02pidd","DataDictPassword": "WebAPIPlant02pidd",
"SchemaTablespace": "USERS","SchemaTempTablespace": "TEMP",
"DataDictTablespace": "USERS","DataDictTempTablespace": "TEMP",
"ReferenceDataPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Reference Data\\P&ID Reference Data"
},
{
"ApplicationType": "Spel",
"SchemaUserName": "WebAPIPlant02el","SchemaPassword": "WebAPIPlant02el",
"DataDictUserName": "WebAPIPlant02eld","DataDictPassword": "WebAPIPlant02eld",
"RefSchemaUserName": "WebAPIPlant02elref","RefSchemaPassword": "WebAPIPlant02elref",
"SchemaTablespace": "USERS","SchemaTempTablespace": "TEMP",
"DataDictTablespace": "USERS","DataDictTempTablespace": "TEMP",
"RefSchemaTablespace": "USERS","RefSchemaTempTablespace": "TEMP",
"ReferenceDataPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\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 for integration. |
|
plant |
Section under which plant parameters are specified |
|
|
Id / Name |
<Plant Name> |
The name the plant will have after loading. The Id and Name parameters must have the same value, and this value must be unique 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> |
|
|
DatabaseServer |
Can be the server on which the site .ini file is located, if required |
|
|
SystemUser |
The case-sensitivity of this value depends on how the DBA defines it for the database |
|
|
SystemPassword |
||
|
SchemaUserName |
Can have same name as plant |
|
|
SchemaPassword |
Can have same name as plant |
|
|
DataDictUserName |
Can use name of plant+'d' |
|
|
DataDictPassword |
Can use name of plant+'d'. |
|
|
SchemaTablespace |
USERS |
|
|
SchemaTempTablespace |
TEMP |
Used only while loading the plant |
|
DataDictTablespace |
USERS |
|
|
DataDictTempTablespace |
TEMP |
Used only while loading the plant. |
|
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. |
|
ReferenceDataPath |
Path to your application's reference data |
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.