LoadObject client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

Parameter 1

Interface name to search

Parameter 1 default

None

Parameter 1 description

The name of the interface definition to query by

Parameter 1 type

String

Parameter 2

Object name or UID

Parameter 2 default

None

Parameter 2 description

The name of UID of the object to be retrieved. For example:

• $Plant – name of the plant

• $User – name of the logged in user

• CURRENTCONFIG – name of the create configuration

• CURRENTQUERYCONFIG – name of the query configuration

• CONFIGLEVELn – Name of the configuration at level n. For example, CONFIGLEVEL1 = plant

Parameter 2 type

String

Parameter 3

Reload on change of create configuration (level 1= plant)

Parameter 3 default

None

Parameter 3 description

If True, the load object is rerun each time the user changes the plant Create configuration. For example, it is used on SPFPlantDrillDown to replace the plant in the tree view when the create configuration is changed.

Parameter 3 type

Boolean

Parameter 4

Reload on change of query configuration

Parameter 4 default

None

Parameter 4 description

This setting is to refresh an object in the tree that can have objects from many configurations related to it.

An example is HomeColDrillDown. A user may have expanded the contents of home collection in Plant A and Project 1 and then added Project 2 to the query configuration. Unless the home collection is refreshed, the user will not see the Project 2 items.

The reason this is not always done is because it collapses an expanded relationship. For example, the classification tree stays expanded.

Parameter 4 type

Boolean

Parameter 5

Allow multi configuration relationship expansions

Parameter 5 default

None

Parameter 5 description

Set to False to load objects into the tree view in the context of the create configuration only. This results in all relationship expansion from this node being in this context.

Parameter 5 type

Boolean