RegisterAuthoringTool client API - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The RegisterAuthoringTool client API is used to register a tool with a selected plant. You can register the Instrument Process Design (IPD), Line List Authoring (LLA), Plant Breakdown Structure (PBS), and Process Case tools with a selected plant.

Argument

Description

Parameter 1

Tool ID

Parameter 1 default

None

Parameter 1 description

The tool ID of the registering tool, for example, PBS, LLA, IPD, and so on.

Parameter 1 type

String

Parameter 2

Domain

Parameter 2 default

None

Parameter 2 description

This is the domain of the authoring tool.

Parameter 2 type

String

Parameter 3

Database Code

Parameter 3 default

None

Parameter 3 description

The database code of the authoring tool. The database code is included in the authoring signature name. This is optional.

Parameter 3 type

String

The following methods use the RegisterAuthoringTool client API to register tools with a plant in the Web Client.

  • Register IPD

  • Register LLA

  • Register PBS

  • Register ProcessCase