Prompted API column functions - 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 following examples show the entry in the Prompted API column and the results expected when data is imported to match a specific requirement in a target system configuration.

For information on using functions in the Prompted API column, see Use the Prompted API column.

Function name

Prompted API sample string

Result

GetEnumEntries

func.GetEnumEntries("SPFCountries")

The prompted box contains the entries in the target system's SPFCountries enumeration, and displays the name, and stores the UID.

GetObjectPropertiesByType

func.GetObjectPropertiesByType("PPMTag", "TAG_*", "Name", "UID")

The prompted box contains the tags in the target system that have a name beginning with "TAG_", displays the name, and stores the UID.

GetValueFromTargetSystemObjects

func.GetValueFromTargetSystemObjects("#SPFEquipmentClass", "Description", "Name")

The prompted box contains the equipment classifications in the target system, displays the description, and stores the name.

GetValuesFromTargetSystemRelExpansion

func.GetValuesFromTargetSystemRelExpansion("+SPFConfigurationTree", "#SPFPlant,.Name='PlantA'", "Name", "UID")

The prompted box contains the subconfigurations for PlantA in the target system, displays the name and stores the UID.