Environment variable support - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

It is also possible to access the environment object that contains properties about the current user's session, such as the user name, access groups, and so on.

Environment object properties

The following environment object properties can be used with conditions:

Object Property

Description

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 WebClient based on a session parameter.

CLASSDEFOBJ

This returns the ClassDef of an object. For example: obj.CLASSDEFOBJ.Name.

CONFIG1, CONFIG2, CONFIG3,

Name of the create configuration at the specified level.

CONFIGCREATE

Current create configuration string.

CONFIGLEVEL

Current create configuration level, such as 0, 1, 2, and so forth.

CREATECONFIGLEVEL1OBJ, CREATECONFIGLEVEL 2OBJ,

Exposes the create configuration object at the specified level to support access to additional properties on this object.

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 2024/01/30.

CURRENTTIME

The current time format 2024/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,

Name of the query configuration at the specified level.

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.

USERUSERTYPE

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