Environment variable support - 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)

Conditions environment object properties and their meanings and examples (where required)

Object properties

Meanings

ACCESSGROUPSFORUSERIN CREATECONFIG

This returns a list of access groups associated with the current create configuration/user (comma separated string)

ACCESSGROUPSFORUSERIN QUERYCONFIG

This returns a list of access groups associated with the current query configuration/user (comma separated string)

CALLEDFROM

As above

CALLEDFROMDIALOG

Returns VBClient/WebClient based on a session parameter

CLASSDEFOBJ

This returns the ClassDef of an object

For example: obj.CLASSDEFOBJ.Name

CONFIG1, CONFIG2, ..5

Name of the create configuration at the specified level

CONFIGCREATE

Current create configuration string

CONFIGLEVEL

Current create configuration level 0, 1, 2, and so forth

CREATECONFIGLEVEL1OBJ, CREATECONFIGLEVEL 2, ..5OBJ

Exposes the create configuration object at the specified level to support access to additional properties on this object (1... 5 supported)

CREATECONFIGOBJ

Exposes the current create configuration object to support access to additional properties on this object

For example: ENV.CREATECONFIGOBJ.Property

CREATECONFIGPARENTOBJ

Exposes the configuration above the current create configuration object to support access to additional properties on this object. This provides access to the plant properties from the project configuration

For example: ENV.CREATECONFIGPARENTOBJ.Property

CREATECONFIGSTRING

Comma separated list of all current create configuration names

CREATECONFIGUID

Current create configuration UID

CURRCONFIGLEVELNAME

Same as QUERYCONFIGSTRINGS

CURRENTDATE

The current date format 2019/01/30

CURRENTTIME

The current time format 2019/01/30-10:38:12:991

CURRENTYMD

The current date in year/month/day format

For example: ENV.CURRENTYMD >= obj.SPFStepTargetDate

EFFECTIVITYDATE

The effective date is set to point in time you want to view data

HOSTNAME

Current SmartPlant Foundation server machine name

OWNINGGROUPSFORCREATE CONFIG

All valid owning groups at this configuration level

OWNINGGROUPSFORQUERY CONFIG

All valid owning groups at this configuration level

OWNINGGROUPSFORUSERIN CREATECONFIG

All valid owning groups for this user at the current create configuration level

OWNINGGROUPSFORUSERIN QUERYCONFIG

All valid owning groups for this user at the current query configuration level

QUERYCONFIGLEVEL

Current query configuration level 0,1,2, and so forth

QUERYCONFIGUIDS

Comma separated list of all current query configuration UIDs

QUERYCONFIGSTRINGS

Comma separated list of all current query configuration names

QUERYCONFIG1, QUERYCONFIG2, ..5

Name of the query configuration at the specified level

SPFOPTIONS

This returns the SystemOptions object, which is used to read system settings when evaluating conditions. Any property on SystemOptions can be used with the applicable condition

Use the following syntax: SPFOPTIONS.[PropertyName]

For example: SPFOPTIONS.AllowPDSNonPDSMerging

In this example, the condition AllowPDSNonPDSMerging uses the property Allow merge of PDS Non-PDS Documents on SystemOptions

USER

Exposes the currently logged in ISPFLoginUser object to support access to additional properties on this object

USERDEFAULTCREATECONFIG

Current user default create configuration

USERNAME

Current user's login user name

USERORGANIZATIONNAME

Current user company name

USERSACTUALNAME

Name of the current user

USERUSERGROUPS

Comma separated list of user groups that the current user belongs to. It is better to use the ones below

USERUSERTYPE

Returns Full, E-mail, or Paper based on whether the current user class has the active domain of ISPFLoginUser, ISPFEmailUser, or ISPFPaperUser