The following is a list of descriptions for the environment variables found in HxGN SDx. These environment variables can be used when creating conditions, security rules, ENS, and Data Validator import mappings.
Data Validator does not provide an equivalent environment variable when the ConfigLevel1OrBlank
environment variable is used as the unique ID definition or unique key definition
for a class definition.
|
Environment Variable |
Description |
Example |
|---|---|---|
|
ACCESSGROUPSFORUSERINCREATECONFIG |
All valid access groups associated with the current create configuration/user (user's name). |
UserAdmin,InstallationAdmin,SuperUserGroup |
|
ACCESSGROUPSFORUSERINQUERYCONFIG |
All valid access groups associated with the current query configuration/user (user's name). |
VTLDataController,VTLDataMapper |
|
ALLDISCIPLINESFORCREATECONFIG |
All disciplines associated with the current create configuration. If no disciplines are found for the current create configuration, the environment variable returns all the disciplines present in the next higher configuration level. |
DC_CV, DC_EL, DC_MACH, DC_MECH-N |
|
ALLDISCIPLINESFORQUERYCONFIG |
All disciplines associated with the current query configuration. If no disciplines are found for the current query configuration, the environment variable returns all the disciplines present in the next higher configuration level. If no disciplines are found for the current query configuration or any of the higher configuration levels, the environment variable returns a blank value. |
MECH-PR, MECH-N |
|
ALLDOMAINSFORUSER |
All domains valid for the current user. |
InstD,SPFLLADesD,LLAD,SPFREFERENCE,METASCHEMA,SPF,VTL |
|
ALLROLEASSIGNEDACTIVEUSERSINCREATECONFIG |
Returns all the users who have any role assignment in the current create configuration. Disabled users are ignored. |
HSV_DC, HSV_DE |
|
ALLROLEASSIGNEDUSERSINCREATECONFIG |
Returns all the users (including disabled users) who have any role assignment in the current create configuration. |
HSV_DC, HSV_DE |
|
CALLEDFROM |
Returns the string from the called client. For example, VBClient/WebClient based on a session parameter. |
VBClient |
|
CALLEDFROMDIALOG |
Returns the string from the called client based on a session parameter. For example, VBClient/WebClient. |
VBClient |
|
CLASS |
Returns the class definition of an object. |
FDWTag |
|
CLASSDEFOBJ |
Returns the class definition of an object. |
FDWTag |
|
CLOUDURL |
Returns the fully-qualified URL path to the Desktop Client site. This is used in email definitions to send notifications about workflow objects to Cloud users. The Cloud users can then access the related workflow object in their To Do List by clicking the URLs in the email notification. |
https://opusindiatest.ingrspcloud.net/?App=9aea00beca0c46ea94059e11876acda1 ({ENV.CLOUDURL: /CONFIGUID PL_PlantA /API QFindObject /ARG1 ISPFWorkflowItem /CRITERIA ssssss} |
|
COLLABORATIONISSUEPURPOSESBYCREATECONFIG |
Returns the UIDs of the issue purposes related to the current create configuration. The issue purposes are returned from the parent configuration if the current create configuration is not related to any issue purpose. |
PIP_IFR, PIP_AB, PIP_IFD, PIP_IFC, PIP_Prelim, PIP_Final |
|
COLLABORATIONISSUEPURPOSESBYNAMEINCREATECONFIG |
Returns the names of the issue purposes related to the current create configuration. The issue purposes are returned from the parent configuration if the current create configuration is not related to any issue purpose. |
IFR, AB, IFD, IFC, Prelim, Final |
|
COLLABORATIONPROJECT |
Returns the current collaboration project if the ISCLBCollaborationScope interface is realized on it. If not, returns the parent configuration if the ISCLBCollaborationScope interface is realized on the parent configuration. |
PLANTA |
|
CONFIG |
Returns the configuration of an object. |
PlantA |
|
CONFIG1, CONFIG2, ..5 |
Name of the create configuration at the specified level |
PlantA, Project1... |
|
CONFIGCREATE |
Current create configuration string includes parent configurations. So if in project scope will include the plant. |
PR_Project_1 |
|
CONFIGLEVEL |
Current create configuration level. For example, 0, 1, 2, and so on. |
2 |
|
CONFIGOBID |
Returns the object ID of the plant or project in which the requested object exists |
000JGNA |
|
CONFIGUID |
Returns the UID of the configuration of the object. |
PL_PlantA |
|
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) |
ENV.CREATECONFIGLEVEL1OBJ.Property |
|
CREATECONFIGOBJ |
Exposes the current create configuration object to support access to additional properties on this object |
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 |
ENV.CREATECONFIGPARENTOBJ.Property |
|
CREATECONFIGSTRING |
Current create configuration name |
PlantA |
|
CREATECONFIGUID |
Current create configuration UID. |
PL_PlantA |
|
CURRCONFIGLEVELNAME |
Current configuration level name. |
Project1 |
|
CURRENTDATE |
Current date. |
2022/10/30 |
|
CURRENTTIME |
Current time. |
2022/10/30-10:38:12:991 |
|
CURRENTYMD |
Current date in the year/month/day format. |
2022/10/30 |
|
DISCIPLINESFORUSERINCREATECONFIG |
Compares the disciplines on role assignments of users with the disciplines on create configuration and:
|
MECH-PR, MECH-N |
|
DISCIPLINESFORUSERINCREATECONFIG_OR_ALL |
Returns the disciplines as per the DISCIPLINESFORUSERINCREATECONFIG variable. If no disciplines are found, it returns all the disciplines in the create configuration. |
MECH-PR, MECH-N |
|
DOCCLASSIFICATIONSINCREATECONFIG_OR_ALL |
Returns the UIDs of the document classifications related to the current create configuration.
|
SDC_Engineering, SDC_Documents, SDC_MDR |
|
DOCCLASSIFICATIONNAMESINCREATECONFIG_OR_ALL |
Returns the names of the document classifications related to the current create configuration.
|
Engineering, Documents, MDR |
|
DOCCLASSIFICATIONSINQUERYCONFIG_OR_ALL |
Returns the UIDs of the document classifications related to the query configurations.
|
SDC_Engineering, SDC_Documents, SDC_MDR |
|
HOSTNAME |
Current Data Validator server machine name. |
SERVER-PROJECT1 |
|
JOBDESCRIPTION |
Current Data Validator job description. |
EnvironmentVariableExamples |
|
JOBNAME |
Current Data Validator job name. |
ENVIRON1 |
|
LOGINUSERDEFAULTROLES |
|
Site Engineer PAB |
|
OBJDEFUID |
Returns the class definition of an object. |
FDWTag |
|
OWNINGGROUPSFORCREATECONFIG |
All valid owning groups at the current create configuration level. |
ADMIN,OPEN TO ALL, SDVADMIN |
|
OWNINGGROUPSFORQUERYCONFIG |
All valid owning groups at the current query configuration level. |
ADMIN,OPEN TO ALL, SDVADMIN |
|
OWNINGGROUPSFORUSERINCREATECONFIG |
All valid owning groups for the user at the current create configuration level. |
ENGINEER,ADMIN,OPEN TO ALL, SDVADMIN |
|
OWNINGGROUPSFORUSERINQUERYCONFIG |
All valid owning groups for the user at the current query configuration level. |
ENGINEER,ADMIN,OPEN TO ALL, SDVADMIN |
|
QUERYCONFIG1, QUERYCONFIG2,3,4,5 |
Name of the query configuration at the specified level. |
PlantA |
|
QUERYCONFIGLEVEL |
Current query configuration level. For example 0,1,2 and so on. |
1 |
|
QUERYCONFIGSTRINGS |
All current query configuration names in a comma separated list. |
PlantA, Project1 |
|
QUERYCONFIGUIDS |
All current query configuration UIDs in a comma separated list.. |
PL_PlantA, PR_Project1 |
|
SDACLIENTURL |
Returns the fully-qualified URL path to the Web Client site. This is used in email definitions to send notifications about workflow objects to Web Client users. The users can then access the related workflow object in their To Do List by clicking the URLs in the email notification. |
https://<server>/<WCSite> |
|
SECURITYCODESFORUSERINCREATECONFIG |
All valid security codes associated with the current create configuration or user. |
Proprietary, Unclassified, Restricted |
|
SECURITYCODESFORUSERINQUERYCONFIG |
All valid security codes associated with the current query configuration or user. |
Proprietary, Unclassified, Restricted |
|
SERVERURL |
Current Data Validator server address. |
http://localhost/SPFServer |
|
SESSIONID |
Current Data Validator session identification. |
aa1f956c-d28e-4fb7-83c4-c6e51d109618 |
|
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. |
SPFOPTIONS.SPFEnforcePasswordPolicy |
|
TAGCLASSIFICATIONSINCREATECONFIG_OR_ALL |
Returns the UIDs of the tag classifications related to the current create configuration.
|
FTC_Equipment, FTC_Instrument |
|
TAGCLASSIFICATIONNAMESINCREATECONFIG_OR_ALL |
Returns the names of the tag classifications related to the current create configuration.
|
Equipment, Instrument |
|
TAGCLASSIFICATIONSINQUERYCONFIG_OR_ALL |
Returns the UIDs of the tag classifications related to the query configurations. If any of the query configuration is not related to any tag classifications, returns the UIDs from the parent configuration. If there are no related parent tag classifications, returns the entire classification tree. |
FTC_Equipment, FTC_Instrument |
|
TEMPLATECLASSIFICATIONSINCREATECONFIG_OR_ALL |
Returns the UIDs of the template classifications related to the current create configuration. If the current create configuration is not related to any template classifications, returns the UIDs from the parent configuration. If there are no related parent template classifications, returns the entire classification tree. |
Datasheet Template, XLS Template |
|
TEMPLATECLASSIFICATIONNAMESINCREATECONFIG_OR_ALL |
Returns the names of the template classifications related to the current create configuration. If the current create configuration is not related to any template classifications, returns the names from the parent configuration. If there are no related parent template classifications, returns the entire classification tree. |
Excel Template, XLS Template |
|
TEMPLATECLASSIFICATIONSINQUERYCONFIG_OR_ALL |
Returns the UIDs of the template classifications related to the query configurations. If any of the query configuration is not related to any template classifications, returns the UIDs from the parent configuration. If there are no related parent template classifications, returns the entire classification tree. |
Datasheet Template, XLS Template. |
|
USER |
Exposes the currently logged in ISPFLoginUser object to support access to additional properties on this object. |
ENV.USER.Property |
|
USERDEFAULTCREATECONFIG |
Current user's default create configuration. |
PlantA |
|
USERNAME |
Current user's login user name. |
SDVADMIN |
|
USERORGANIZATIONNAME |
Current user's company name. |
Hexagon |
|
USERORGANIZATIONNAMEWITHDELIMITER |
Returns the user organization name with delimiter appended. |
®HSV® |
|
USERSACTUALNAME |
Name of the current user |
John Smith |
|
USERUID |
Returns the UID of the user. |
USR_SDxAdmin |
|
USERUSERGROUPS |
Current user query access groups. |
ENGINEER,ADMIN,OPEN TO ALL, SDVADMIN |
|
USERUSERTYPE |
Current user's types. |
Full |
|
USERWORKAREANAMES |
When a user runs a query in SDx to return shared objects, the system evaluates this environment variable.
|
WorkAreaDefintionUID1 |
|
VIRTUALDIRECTORY |
Returns the path of a web folder created in IIS that points to a physical folder on the Web server. Virtual directories are used by the software to run applications and services from the application server and to transfer files between file servers and clients. |
C:\SDx Server Files\Web_Sites\SDxU38Server |