Use the following requests in sequence to register Smart P&ID and Smart Electrical plants with HxGN SDx2, to enable integration and data sharing.
-
To create a new HxGN SDx2 registration, your administrator must create a new client in the Authorization server. Make sure that you have obtained this required authentication data from your HxGN SDx2 administrator before registering your plant with HxGN SDx2.
-
You must have Full Control permissions to register your plant with HxGN SDx2.
-
During the registration, to support data exchange with HxGN SDx2, the software prepares the database to accommodate data sharing.
GET request URI to obtain client credentials
-
Service Root URI: https://<HxGN SDx2 server name>/<IIS application name>/sdxservice
-
Resource path: /api/v3/SIO/GetApplicationClientCredentials
POST request URI to register a plant using the client credentials
-
Service Root URI: https://<Web API server name>/<IIS application name>/sem/v4
-
Resource path: /Sites('<Site name>')/Plants('<Plant name>')/Applications('<Id>')/Registrations
The following example shows how to register a Smart P&ID plant with HxGN SDx2. To register a Smart Electrical plant, replace <Id> with Spel in the resource path.
Sample URI
GET
https://hexagonali.dev.hxgnsmartcloud.com/semsdx/sdxservice/api/v3/SIO/GetApplicationClientCredentials
POST
https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v4/Sites('WebAPISite01')/Plants('WebAPIPlant01')/Applications('Sppid')/Registrations
Sample JSON request
{
"URL": "https://hexagonali.dev.hxgnsmartcloud.com/semsdx/sdxservice",
"WorkAreaName" : "PB",
"ClientCredentialsClientIdKey" : "Egs3+ANHmk0ZyaObOARO7N4xoVxpp9EHaOo=",
"ClientCredentialsClientSecretKey" : "uonMwcE+3rPCfEjoJ4yQjx60n34OWky8VNU6e/LpyrLkuE2h9ZX4MjL+pThp/KQFmVIEMyhJtlnFOdkx8MXVean0DVb2h5Q=",
"ToolDescription" : "RegisterPBWPTool"
}
JSON request parameters
|
Parameter |
Value |
Description and Comments |
|---|---|---|
|
URL |
<Server URL> |
Provide the HxGN SDx2 site URL to register with. |
|
WorkAreaName |
<Work area name> |
Provide the HxGN SDx2 Work Area name to connect to. |
|
ClientCredentialsClientIdKey |
<Client ID> |
Unique ID that identifies the Smart Client. |
|
ClientCredentialsClientSecretKey |
<Client Secret> |
Unique key that authenticates the Smart Client. |
|
ToolDescription |
Unique description of the design tool. |
Sample response
{
"@odata.context":"https://localhost/webapi4.0/sem/v4/$metadata#Sites('WebAPISite01')/Plants('WebAPIPlant01')/Applications('Sppid')/Registrations",
"value": [
{
"Id": "CLPSDX",
"ConcurrencyToken": null,
"Url": "https://hexagonali.dev.hxgnsmartcloud.com/semsdx/sdxservice",
"ToolSignature": "AAAC",
"PlantId": "PL_PipelinePlant",
"PlantName": "PipelinePlant",
"SchemaVersion": "02.02.03.0001",
"Type": "CLPSDX"
}
]
}