Prerequisites
Before you can configure a materials web system, you must install and configure the Smart Materials Web API on your machine. Once configured, it can be found under the Smart APIs tab in Smart API Manager (SAM), and you can establish a connection between Smart Materials and Smart Construction via the connection form in SmartPlant Foundation.
-
Install SmartPlant Materials 2016 R4 (8.4) or 2020 (10.0) with API version 2.2 or later.
-
Install Smart Materials Web API on your machine.
-
Configure the Web API to Smart API Manager (SAM) either manually or by using using “Intergraph.WebApi.ServiceConfigurationTool.exe” which will configure it automatically. See Intergraph Smart Construction API and Programming Reference for more information.
Configure the materials web system
-
Configure your identify provider as instructed by Smart Materials. The two supported grant types, or authentication flows, are Client Credentials and Resource Owner. We recommend using the Client Credentials flow.
-
Log on to SmartPlant Foundation Desktop Client as an administrator.
-
Verify that your active scope is set. For more information, see Set your active scope in SmartPlant Foundation Desktop Client.
-
Click Smart Construction > New > Administration > Materials Web System.
-
Enter the Main details.
Name
Enter the plant name from SmartPlant Foundation.
Description
Optional
-
Enter the Material information details.
Project
Enter the project name from your materials system.
Discipline
Enter "SITE".
Language
Enter "ENGLISH".
This must match the Data Language in Smart Materials.
Project forecast name
Enter the project forecast name.
This must match the project forecast name in Smart Materials.
Access point
Enter the URL for the materials system API.
The URL path can be found in SAM > Smart APIs tab > URL.
Company ID
Enter the company ID from the materials system.
This can be found in SAM.
The Language field is case-sensitive.
If you specify a project forecast name, the materials status for all the BOM entries
that match the project forecast name is retrieved. If you do not specify the project
forecast name, the materials status for all the BOM entries is retrieved from the
latest forecast run of the last 180 days.
-
Enter the Web access authorization details. Information from your identity provider configuration will be needed for this step.
-
Client Credentials flow option
Authorization server
Enter the authorization server URL.
Grant type
Enter "Client Credentials".
Username
Leave blank.
Password
Leave blank.
Client ID
Enter the client ID from your identity provider.
Client secret
Enter the client secret from your identity provider.
Scope
Enter the resource identifier value from your identity provider. It must be the same as the resource ID of the Smart Materials Web API used in SAM.
Resource
Enter the same value used for Scope.
-
Resource Owner flow option
Authorization server
Enter the authorization server URL.
Grant type
Enter "Password".
Username
Enter the username for the authorization server.
Password
Enter the password for the authorization server.
Client ID
Enter the client ID from your identity provider.
Client secret
Enter the client secret from your identity provider.
Scope
Enter the resource identifier value from your identity provider. It must be the same as the resource ID of the Smart Materials Web API used in SAM.
Resource
Enter the same value used for Scope.