FrameworkRetrieve 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 FrameworkRetrieve client API is used to retrieve data from the data warehouse to authoring.

Argument

Description

Parameter 1

Tool adapter prog ID

Parameter 1 default

None

Parameter 1 description

The tool adapter prog ID used in the method argument.

Parameter 1 type

String

Parameter 2

Domain

Parameter 2 default

None

Parameter 2 description

The domain UID of the authoring tool used in the method argument.

Parameter 2 type

String

Parameter 3

Adapter Code

Parameter 3 default

None

Parameter 3 description

Adapter code or document type that is used to identify the map file.

Parameter 3 type

String

Parameter 4

Database Code

Parameter 4 default

None

Parameter 4 description

The database code ID that can be used for the data warehouse.

Parameter 4 type

String

The following methods use the FrameworkRetrieve client API to retrieve data from the data warehouse into an authoring environment.

  • FrameworkRetrievePBS

  • FrameworkRetrieveIPD

  • FrameworkRetrieveProcessCase

  • LLARetrieve