Configure Web API through Configuration tool - Intergraph Smart Materials - 2.3 - Installation & Upgrade - Hexagon

Intergraph Smart Materials Web API Installation (2.3)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Installation & Upgrade
Version Smart Materials Web API
2.3
  1. On your system, open the command prompt and navigate to the configuration tool folder (For example, (C:\Program Files\INTERGRAPH\Smart Materials WebAPI 2.3\tools\WEBAPI ConfigTool).

  2. Type SmatAPIConfigTool.exe and invoke a help command (like C:\Program Files\INTERGRAPH\Smart Materials WebAPI 2.3\tools\WEBAPI ConfigTool >SmatAPIConfigTool.exe -?)

    SHARED Tip You can invoke a help command by using any of these options; -?, -h, or --help.

  3. You can view four major commands as following:

    • Oauth

    • db

    • apilog

    • upgrade.

    Command promt for config tool

  4. To update the oauth details, type the command and invoke help command like C:\Program Files\INTERGRAPH\Smart Materials WebAPI 2.3\tools\WEBAPI ConfigTool>SmatAPIConfigTool.exe oauth -? .

    If you are a new user, then first configure authorization details/server (for more, view Configure authorization servers for SMAT Web API).

    The oauth consists of six arguments and you must pass a valid value for them.

    Argument

    Description

    Azure Server

    SAM Server

    OKTA server

    baseUri

    Base Uri for the service or api

    Mandatory

    Mandatory

    Mandatory

    issuerUri

    Identity Server Issuer address

    Mandatory

    Mandatory

    Mandatory

    resourceId

    resource id

    Mandatory

    Mandatory

    Mandatory

    secret

    secret details if any

    Optional

    Optional

    Optional

    audienceId

    Audience ID

    Mandatory

    Optional

    Optional

    requiredscopes

    Required scopes and use comma(,) if multiple scopes are available

    Mandatory

    Optional

    Optional

    The oauth details format can be given as:

    (C:\Program Files\INTERGRAPH\Smart Materials WebAPI 2.3\tools\WEBAPI ConfigTool>SmatAPIConfigTool.exe oauth http://localhost/ http://sam.ingrnet.com/ 12-8748-3837 "" "" "")

  5. To update the db details, type the command and invoke help command like C:\Program Files\INTERGRAPH\Smart Materials WebAPI 2.3\tools\WEBAPI ConfigTool>SmatAPIConfigTool.exe db -?.

    The db consists of two arguments and you must pass a valid value for each of them.

    Argument

    Description

    pwd

    M_WEBAPI user password

    datasource

    tns name or full descriptor

  6. To update the apilog details, type the command and then invoke help command like

    C:\Program Files\INTERGRAPH\Smart Materials WebAPI 2.3\tools\WEBAPI ConfigTool>SmatAPIConfigTool.exe apilog -?.

    The apilog consists of one argument and you must provide it's details.

    Argument

    Description

    dir-path

    Valid directory path

  7. To update the upgrade details, type the command and then invoke help command like

    C:\Program Files\INTERGRAPH\Smart Materials WebAPI 2.3\tools\WEBAPI ConfigTool>SmatAPIConfigTool.exe upgrade -?.

    The upgrade consists of two arguments and you must pass a valid value for each of them.

    Argument

    Description

    client version

    Oracle.DataAccess.Client DLL version.

    Path : C:\Windows\Microsoft.NET\assembly\GAC_64\Oracle.DataAccess\

    EF version

    Oracle.DataAccess.EntityFramework DLL version.

    Path:C:\Windows\Microsoft.NET\assembly\GAC_MSIL\Oracle.DataAccess.EntityFramework

    If the above DLLS are not registered in the server, refer to this topic Install Oracle client.